CustomZones

class CustomZones

Bases: Flow360BaseModel

CustomZones class for creating volume zones from custom volumes or seedpoint volumes. Names of the generated volume zones will be the names of the custom volumes.

Example

>>> fl.CustomZones(name="Custom zones", entities=[custom_volume1, custom_volume2], )

---

Attributes

name: str

Name of the CustomZones meshing setting.

Default:

'Custom zones'

entities: EntityList[CustomVolume, SeedpointVolume]

The custom volume zones to be generated.

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