.. module:: flowfield

####################
Class: ``FlowField``
####################

.. autoclass:: pykitPIV.flowfield.FlowFieldSpecs

.. autoclass:: pykitPIV.flowfield.FlowField

.. autofunction:: pykitPIV.flowfield.FlowField.print_available_fields

.. autofunction:: pykitPIV.flowfield.FlowField.generate_constant_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_shearing_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_random_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_sinusoidal_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_checkered_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_chebyshev_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_spherical_harmonics_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_directionally_divergent_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_radial_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_potential_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_taylor_green_vortex_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.generate_langevin_velocity_field

.. autofunction:: pykitPIV.flowfield.FlowField.compute_displacement_field

.. autofunction:: pykitPIV.flowfield.FlowField.upload_velocity_field

*********************************************
Flow field utilities
*********************************************

.. autofunction:: pykitPIV.flowfield.compute_divergence

.. autofunction:: pykitPIV.flowfield.compute_vorticity

.. autofunction:: pykitPIV.flowfield.compute_rate_of_strain_tensor

.. autofunction:: pykitPIV.flowfield.compute_rate_of_rotation_tensor

.. autofunction:: pykitPIV.flowfield.compute_q_criterion