OctreeSpacing

class OctreeSpacing

Bases: Flow360BaseModel

Helper class for octree-based meshers. Holds the base for the octree spacing and lows calculation of levels.

Attributes

base_spacing: LengthType.Positive

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

to_level(spacing)

Can be used to check in what refinement level would the given spacing result and if it is a direct match in the spacing series.

Parameters:

spacing (Annotated[_Constrained, PlainSerializer(func=~flow360.component.simulation.unit_system._dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)])

check_spacing(spacing, location)

Warn if the given spacing does not align with the octree series.

Parameters:

• spacing (Annotated[_Constrained, PlainSerializer(func=~flow360.component.simulation.unit_system._dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)])

• location (str)

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