API Reference

• Xarray Module
  • Introduction
  • Usage
  • Accessor methods
    • TfvDomain
      • TfvDomain
        • TfvDomain.get_curtain()
        • TfvDomain.get_profile()
        • TfvDomain.get_sheet()
        • TfvDomain.get_statistics()
        • TfvDomain.get_timeseries()
        • TfvDomain.plot()
        • TfvDomain.plot_curtain()
        • TfvDomain.plot_curtain_interactive()
        • TfvDomain.plot_curtain_vector()
        • TfvDomain.plot_interactive()
        • TfvDomain.plot_vector()
        • TfvDomain.prep_interactive_slider()
    • TfvTimeseries
      • TfvTimeseries
        • TfvTimeseries.get_location()
        • TfvTimeseries.get_timeseries()
        • TfvTimeseries.plot()
• Extractor Module
  • FvExtractor
    • FvExtractor
      • FvExtractor.nc2
      • FvExtractor.nv2
      • FvExtractor.is_tri
      • FvExtractor.is_quad
      • FvExtractor.edge_node
      • FvExtractor.weights
      • FvExtractor.tri_cell_node
      • FvExtractor.tri_cell_index
      • FvExtractor.nc
      • FvExtractor.nz
      • FvExtractor.idx2
      • FvExtractor.idx3
      • FvExtractor.idx4
      • FvExtractor.wli
      • FvExtractor.bli
      • FvExtractor.get_curtain_cell()
      • FvExtractor.get_curtain_cell_geo()
      • FvExtractor.get_curtain_cell_index()
      • FvExtractor.get_curtain_edge()
      • FvExtractor.get_curtain_grid()
      • FvExtractor.get_integral_data()
      • FvExtractor.get_mask_vector()
      • FvExtractor.get_profile_cell()
      • FvExtractor.get_raw_data()
      • FvExtractor.get_sheet_cell()
      • FvExtractor.get_sheet_grid()
      • FvExtractor.get_sheet_node()
      • FvExtractor.get_z_layer_faces()
      • FvExtractor.write_data_to_ascii()
      • FvExtractor.write_time_series_file()
• Time Series Module
  • FvTimeSeries
    • FvTimeSeries
      • FvTimeSeries.get_data()
      • FvTimeSeries.get_integral_data()
      • FvTimeSeries.get_mask_vector()
      • FvTimeSeries.get_raw_data()
      • FvTimeSeries.get_z_layer_faces()
• Visual Module
  • SheetPatch
    • SheetPatch
      • SheetPatch.zoom()
  • SheetContour
    • SheetContour
      • SheetContour.zoom()
  • SheetVector
    • SheetVector
      • SheetVector.zoom()
  • ParticlesScatter
    • ParticlesScatter
      • ParticlesScatter.zoom()
• Viewer Module
  • Slider
  • Viewer
  • ColourBar
• Particles Module
  • FvParticles
    • FvParticles
      • FvParticles.nc
      • FvParticles.nt
      • FvParticles.np
      • FvParticles.get_mask_vector()
      • FvParticles.get_raw_data()
      • FvParticles.get_vertical_selection()
• Geometry Module
  • Classes
    • Mesh
      • Mesh
        • Mesh.nc2
        • Mesh.nv2
        • Mesh.is_tri
        • Mesh.is_quad
        • Mesh.edge_node
        • Mesh.weights
        • Mesh.tri_cell_node
        • Mesh.tri_cell_index
        • Mesh.get_cell_index()
        • Mesh.get_grid_index()
        • Mesh.get_intersection_data()
  • Functions
    • is_ccw
      • is_ccw()
    • is_intersection
      • is_intersection()
    • get_intersection
      • get_intersection()
    • get_unit_vectors
      • get_unit_vectors()