5.5. API Reference#
Complete reference documentation for the Flow360 Python API. This section provides detailed information about all classes, functions, and modules available in the Flow360 package.
Getting Started#
Essential components for initializing and configuring Flow360 simulations.
Core setup classes including SimulationParams for configuring simulation parameters
Classes for managing cloud resources: Project, Case, Geometry, SurfaceMesh, VolumeMesh
Geometric entities for defining volumes, surfaces, and points in your simulation domain
Draft context for geometry analysis and surface/edge identification before meshing
Meshing#
Configuration and parameters for mesh generation.
Meshing interfaces, refinements, and zone definitions for surface and volume mesh generation
Geometry and Materials#
Geometric reference and material properties.
Reference geometry definitions for force and moment calculations
Material properties and fluid models
Simulation Configuration#
Physical models, boundary conditions, and solver settings for defining the flow physics and numerical methods.
Freestream conditions, reference values, and operating parameters
Volume physics models: Fluid, Solid, Rotation, BETDisk, ActuatorDisk, PorousMedium
Boundary conditions: Wall, Freestream, Inflow, Outflow, Periodic, SymmetryPlane
Time stepping schemes and temporal discretization methods
Solver numerics, convergence criteria, and algorithm settings
Advanced Features#
Custom expressions, dynamics, and run control.
Custom variables and mathematical expressions for simulation parameters
Custom control laws and coupled physics models
Simulation execution control, restart options, and convergence monitoring
Outputs and Results#
Configuration for simulation outputs and result analysis.
Output classes for volume, surface, slice, probe, force, streamline, and aeroacoustic outputs
Result processing, interpolation, and data manipulation utilities
Reporting#
Report generation and visualization.
Report templates, charts, and data visualization tools