Gravity

class Gravity

Bases: Flow360BaseModel

Gravity class for specifying gravitational body force.

The gravity model applies a body force ρg to the momentum equations and ρ(g·u) to the energy equation, enabling simulation of buoyancy-driven flows. Gravity is applied globally to all fluid zones in the simulation.

Example

Define gravity with Earth’s default values (direction=(0,0,-1), magnitude=9.81 m/s²):

>>> fl.Gravity()

Define gravity with custom direction and magnitude:

>>> fl.Gravity(
...     direction=(1, 0, 0),
...     magnitude=5.0 * fl.u.m / fl.u.s**2,
... )

---

Attributes

direction: Axis

The direction of the gravitational acceleration vector.

Default:

(0, 0, -1)

magnitude: AccelerationType

The magnitude of the gravitational acceleration. For Earth’s surface gravity, use 9.81 m/s².

Default:

9.81 * fl.u.m/fl.u.s**2

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')