AxisymmetricBody

final class AxisymmetricBody

Bases: _VolumeEntityBase

AxisymmetricBody class represents a generic body of revolution in three-dimensional space, represented as a list[(Axial Position, Radial Extent)] profile polyline with arbitrary center and axial direction. Expect first and last profile samples to connect to axis, i.e., have radius = 0.

Example

>>> fl.AxisymmetricBody(
...     name="cone_frustum_body",
...     center=(0, 0, 0) * fl.u.inch,
...     axis=(0, 0, 1),
...     profile_curve = [(-1, 0) * fl.u.inch, (-1, 1) * fl.u.inch, (1, 2) * fl.u.inch, (1, 0) * fl.u.inch]
... )

---

Attributes

name: str

axis: Axis

The axis of the body of revolution.

center: LengthType.Vector

The center point of the body of revolution.

profile_curve: list[LengthType.Pair]

The (Axial, Radial) profile of the body of revolution.

Properties

id: str

Returns private_attribute_id of the entity.

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')