SeedpointVolume

SeedpointVolume#

final class SeedpointVolume[source]#

Bases: _VolumeEntityBase

Separate zone in the mesh, defined by one or more interior seed points. To be used only with snappyHexMesh.

Attributes

point_in_mesh: list[typing.Annotated[typing.Any, BeforeValidator(func=<function _create_validator.<locals>.validate at 0x7bbe21acf5b0>, json_schema_input_type=PydanticUndefined), PlainSerializer(func=<function _create_serializer.<locals>.serialize at 0x7bbe21acf760>, return_type=PydanticUndefined, when_used='always'), WithJsonSchema(json_schema={'type': 'object', 'properties': {'value': {'$ref': 'https://flexcompute.com/schemas/1.0.0/Vector3Json.json'}, 'units': {'type': 'string'}}, 'required': ['value', 'units'], 'additionalProperties': False}, mode=None)]]#

Seed point(s) for this custom volume zone. Accepts either one [x, y, z] point or a list of points [[x, y, z], …]. Use with Snappy requires exactly one point per zone.

axes: Optional[typing.Annotated[tuple[flow360_schema.framework.entity.geometric_types.Axis, flow360_schema.framework.entity.geometric_types.Axis], AfterValidator(func=<function _check_axis_is_orthogonal at 0x7bbe21b69510>)]]#

Principal axes definition when using with PorousMedium

Default:

None

axis: Axis, optional#
Default:

None

center: Any, optional#
Default:

None

Properties

id: str#

Returns private_attribute_id of the entity.

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None