flow360.ReferenceGeometry

class ReferenceGeometry

Bases: Flow360BaseModel

ReferenceGeometry class contains all geometrical related reference values.

Example

>>> ReferenceGeometry(
...     moment_center=(1, 2, 1) * u.m,
...     moment_length=(1, 1, 1) * u.m,
...     area=1.5 * u.m**2
... )
>>> ReferenceGeometry(
...     moment_center=(1, 2, 1) * u.m,
...     moment_length=1 * u.m,
...     area=1.5 * u.m**2
... )  # Equivalent to above

---

moment_center: Annotated[_VectorType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] | None = None

The x, y, z coordinate of moment center.

moment_length: Annotated[_Constrained, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] | Annotated[_VectorType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] | None = None

The x, y, z component-wise moment reference lengths.

area: _serializer, return_type=PydanticUndefined, when_used=always)] | None = None

The reference area of the geometry.

classmethod fill_defaults(ref, params)

Return a new ReferenceGeometry with defaults filled using SimulationParams.

Defaults when missing or when ref is None: - area: 1 * (base_length)**2 - moment_center: (0,0,0) * base_length - moment_length: (1,1,1) * base_length