MeshSliceOutput

class MeshSliceOutput

Bases: Flow360BaseModel

MeshSliceOutput class for mesh slice output settings.

Example

>>> fl.MeshSliceOutput(
...     slices=[
...         fl.Slice(
...             name="Slice_1",
...             normal=(0, 1, 0),
...             origin=(0, 0.56, 0)*fl.u.m
...         ),
...     ],
... )

---

Attributes

name: str

Name of the MeshSliceOutput.

Default:

'Mesh slice output'

entities: EntityList[Slice]

List of output Slice entities.

include_crinkled_slices: bool

Generate crinkled slices in addition to flat slices.

Default:

False

cutoff_radius: LengthType.Positive, optional

Cutoff radius of the slice output. If not specified, the slice extends to the boundaries of the volume mesh.

Default:

None

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