Reference
=========

.. contents::
   :local:
   :depth: 3

FieldView
---------

fieldview
~~~~~~~~~

.. automodule:: fieldview

Scene Discovery
~~~~~~~~~~~~~~~

.. autofunction:: fieldview.get_current_object

.. autofunction:: fieldview.get_all_objects

.. autoclass:: fieldview.ObjectLists
   :members:
   :undoc-members:

Host Control
~~~~~~~~~~~~

.. autofunction:: fieldview.exit

.. autofunction:: fieldview.fv_script

Data
----

fieldview.data
~~~~~~~~~~~~~~

.. automodule:: fieldview.data

Loading Data
~~~~~~~~~~~~

.. autofunction:: fieldview.data.load_plot3d

.. autofunction:: fieldview.data.load_overflow2

.. autofunction:: fieldview.data.load_fvuns

.. autofunction:: fieldview.data.load_vtk_structured

.. autofunction:: fieldview.data.load_acusolve_direct

.. autofunction:: fieldview.data.load_acusolve_fvuns

.. autofunction:: fieldview.data.load_ansys_cfx_fvuns

.. autofunction:: fieldview.data.load_fluent_cff_direct

.. autofunction:: fieldview.data.load_append_sampled_data

.. autofunction:: fieldview.data.load_pw_common

.. autofunction:: fieldview.data.load_cfdpp_fvuns

.. autofunction:: fieldview.data.load_cgns_structured

.. autofunction:: fieldview.data.load_cgns_unstructured

.. autofunction:: fieldview.data.load_cgns_unstructured_hybrid

.. autofunction:: fieldview.data.load_cobalt_fvuns

.. autofunction:: fieldview.data.load_converge_fvuns

.. autofunction:: fieldview.data.load_ensight

.. autofunction:: fieldview.data.load_flow3d_animation

.. autofunction:: fieldview.data.load_flow3d_restart

.. autofunction:: fieldview.data.load_fluent_fvuns

.. autofunction:: fieldview.data.load_fluent_unstructured

.. autofunction:: fieldview.data.load_fluent_cas_dat_direct

.. autofunction:: fieldview.data.load_fluent_direct

.. autofunction:: fieldview.data.load_havoc

.. autofunction:: fieldview.data.load_lsdyna_d3plot

.. autofunction:: fieldview.data.load_lsdyna_state

.. autofunction:: fieldview.data.load_nparc_wind

.. autofunction:: fieldview.data.load_openfoam_direct

.. autofunction:: fieldview.data.load_openfoam_fvuns

.. autofunction:: fieldview.data.load_sc_tetra

.. autofunction:: fieldview.data.load_sc_flow

.. autofunction:: fieldview.data.load_scryu

.. autofunction:: fieldview.data.load_sc_stream

.. autofunction:: fieldview.data.load_starccm_fvuns

.. autofunction:: fieldview.data.load_starcd_fvuns

.. autofunction:: fieldview.data.load_stl

.. autofunction:: fieldview.data.load_surface_sampled_data

.. autofunction:: fieldview.data.load_tecplot_360

.. autofunction:: fieldview.data.load_ultrafluidx_direct

.. autofunction:: fieldview.data.load_vtk_unstructured_hybrid

.. autofunction:: fieldview.data.load_wind_structured

.. autofunction:: fieldview.data.load_wind_unstructured

.. autofunction:: fieldview.data.load_xdb_import

Data Access
~~~~~~~~~~~

.. autoclass:: fieldview.data.Dataset
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.ScalarRegistry
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.ScalarArrayRef
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.VectorRegistry
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.VectorArrayRef
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.PositionRegistry
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.DatasetBounds
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.WindowInfo
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.WindowList
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.WindowSplitResult
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.PerspectiveState
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.CameraPose
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.ViewState
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.CameraState
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.SessionState
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.ProbeResult
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.TransientInfo
   :members:
   :undoc-members:

.. autoclass:: fieldview.data.IntegrationResult
   :members:
   :undoc-members:

Live Session
~~~~~~~~~~~~

.. autofunction:: fieldview.data.get_current

.. autofunction:: fieldview.data.get_session_state

Point Probes
~~~~~~~~~~~~

.. autofunction:: fieldview.data.probe

.. autofunction:: fieldview.data.probe_ijk

Formula
-------

fieldview.formula
~~~~~~~~~~~~~~~~~

.. automodule:: fieldview.formula

Formula Creation
~~~~~~~~~~~~~~~~

.. autofunction:: fieldview.formula.create

.. autoclass:: fieldview.formula.Formula
   :members:
   :undoc-members:

Builder References
~~~~~~~~~~~~~~~~~~

.. autofunction:: fieldview.formula.quantity

.. autofunction:: fieldview.formula.dataset_quantity

Builder Operations
~~~~~~~~~~~~~~~~~~

.. autofunction:: fieldview.formula.mag

.. autofunction:: fieldview.formula.grad

.. autofunction:: fieldview.formula.curl

.. autofunction:: fieldview.formula.nrmlz

.. autofunction:: fieldview.formula.exp

.. autofunction:: fieldview.formula.ln

.. autofunction:: fieldview.formula.log

.. autofunction:: fieldview.formula.sin

.. autofunction:: fieldview.formula.cos

.. autofunction:: fieldview.formula.tan

.. autofunction:: fieldview.formula.asin

.. autofunction:: fieldview.formula.acos

.. autofunction:: fieldview.formula.atan

.. autofunction:: fieldview.formula.atan2

.. autofunction:: fieldview.formula.sqrt

.. autofunction:: fieldview.formula.abs

.. autofunction:: fieldview.formula.div

.. autofunction:: fieldview.formula.vecx

.. autofunction:: fieldview.formula.vecy

.. autofunction:: fieldview.formula.vecz

.. autofunction:: fieldview.formula.dot

.. autofunction:: fieldview.formula.cross

.. autofunction:: fieldview.formula.qcriterion

.. autofunction:: fieldview.formula.lambda2criterion

Constants
~~~~~~~~~

.. autodata:: fieldview.formula.pi

.. autodata:: fieldview.formula.e

.. autodata:: fieldview.formula.unit_x

.. autodata:: fieldview.formula.unit_y

.. autodata:: fieldview.formula.unit_z

.. autodata:: fieldview.formula.alpha

.. autodata:: fieldview.formula.fsmach

.. autodata:: fieldview.formula.re

.. autodata:: fieldview.formula.time

.. autodata:: fieldview.formula.gamma

.. autodata:: fieldview.formula.r

Visualization
-------------

fieldview.vis
~~~~~~~~~~~~~

.. automodule:: fieldview.vis

Object Creation Functions
~~~~~~~~~~~~~~~~~~~~~~~~~

vis.create_coord
""""""""""""""""

.. autofunction:: fieldview.vis.create_coord

vis.create_comp
"""""""""""""""

.. autofunction:: fieldview.vis.create_comp

vis.create_iso
""""""""""""""

.. autofunction:: fieldview.vis.create_iso

vis.create_boundary
"""""""""""""""""""

.. autofunction:: fieldview.vis.create_boundary

vis.create_surface_flows
""""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_surface_flows

vis.create_separation_lines
"""""""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_separation_lines

vis.create_reattachment_lines
"""""""""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_reattachment_lines

vis.create_streamlines
""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_streamlines

vis.create_particle_paths
"""""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_particle_paths

vis.create_plot2d
"""""""""""""""""

.. autofunction:: fieldview.vis.create_plot2d

vis.create_vortex_cores
"""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_vortex_cores

vis.create_annotation_text
""""""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_annotation_text

vis.create_annotation_arrow
"""""""""""""""""""""""""""

.. autofunction:: fieldview.vis.create_annotation_arrow

Coordinate Surface Class
~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.Coord
   :members:
   :undoc-members:
   :inherited-members:

.. autoclass:: fieldview.utils.RuledGridOptions
   :members:
   :undoc-members:

.. autoclass:: fieldview.utils.RuledGridAxisOptions
   :members:
   :undoc-members:

Computational Surface Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.Comp
   :members:
   :undoc-members:
   :inherited-members:

Iso Surface Class
~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.Iso
   :members:
   :undoc-members:
   :inherited-members:

.. autoclass:: fieldview.utils.CuttingPlane
   :members:
   :undoc-members:

Boundary Surface Class
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.Boundary
   :members:
   :undoc-members:
   :inherited-members:

Surface Flows Class
~~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.SurfaceFlows
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.SeparationLines
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.ReattachmentLines
   :members:
   :undoc-members:

Streamlines Surface Class
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.Streamlines
   :members:
   :undoc-members:

Particle Paths Surface Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.ParticlePaths
   :members:
   :undoc-members:

2D Plot Class
~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.Plot2D
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.Plot2DPath
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.Plot2DAxis
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.Plot2DSampling
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.Plot2DAnnotation
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.Plot2DOptions
   :members:
   :undoc-members:

Vortex Cores Class
~~~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.VortexCores
   :members:
   :undoc-members:

Annotation Class
~~~~~~~~~~~~~~~~

.. autoclass:: fieldview.vis.AnnotationText
   :members:
   :undoc-members:

.. autoclass:: fieldview.vis.AnnotationArrow
   :members:
   :undoc-members:

Layout
------

fieldview.layout
~~~~~~~~~~~~~~~~

.. automodule:: fieldview.layout

.. autofunction:: fieldview.layout.get_windows

.. autofunction:: fieldview.layout.current

.. autofunction:: fieldview.layout.select

.. autofunction:: fieldview.layout.split_vertical

.. autofunction:: fieldview.layout.split_horizontal

.. autofunction:: fieldview.layout.get_view_sync

.. autofunction:: fieldview.layout.set_view_sync

.. autofunction:: fieldview.layout.close

View
----

fieldview.view
~~~~~~~~~~~~~~

.. automodule:: fieldview.view

.. autofunction:: fieldview.view.center

.. autofunction:: fieldview.view.fit

.. autofunction:: fieldview.view.reset

.. autofunction:: fieldview.view.align

.. autofunction:: fieldview.view.set_perspective

.. autofunction:: fieldview.view.get_perspective

.. autofunction:: fieldview.view.set_outline

.. autofunction:: fieldview.view.get_outline

.. autofunction:: fieldview.view.set_axis_markers

.. autofunction:: fieldview.view.get_axis_markers

Camera
------

fieldview.camera
~~~~~~~~~~~~~~~~

.. automodule:: fieldview.camera

.. autofunction:: fieldview.camera.pan

.. autofunction:: fieldview.camera.zoom

.. autofunction:: fieldview.camera.dolly

.. autofunction:: fieldview.camera.rotate

.. autofunction:: fieldview.camera.orbit

.. autofunction:: fieldview.camera.look_at

.. autofunction:: fieldview.camera.get_state

.. autofunction:: fieldview.camera.set_state

Export
------

fieldview.export
~~~~~~~~~~~~~~~~

.. automodule:: fieldview.export

.. autofunction:: fieldview.export.export_image

.. autofunction:: fieldview.export.export_png

.. autofunction:: fieldview.export.export_jpg

.. autofunction:: fieldview.export.export_bmp

Utilities
---------

.. automodule:: fieldview.utils

.. autoclass:: fieldview.utils.Colormap
   :members:
   :undoc-members:

.. autoclass:: fieldview.utils.VectorOptions
   :members:
   :undoc-members:

.. autoclass:: fieldview.utils.Legend
   :members:
   :undoc-members:

.. autoclass:: fieldview.utils.ScalarMinMax
   :members:
   :undoc-members:

.. autoclass:: fieldview.utils.RangedValue
   :members:
   :undoc-members:

.. autoclass:: fieldview.utils.Range
   :members:
   :undoc-members:

Constants
---------

.. automodule:: fieldview.constant
   :members:
   :imported-members:
   :undoc-members:

Exceptions
----------

.. automodule:: fieldview.exceptions
   :members: