nimphs.properties.openfoam

Modules

nimphs.properties.openfoam.clip

class NIMPHS_OpenfoamClipProperty

Bases: PropertyGroup

Clip settings.

is_custom_base_cls = False

register_cls = True

scalar: None

Clip scalar settings

Type: NIMPHS_OpenfoamClipScalarProperty

type: None

Clipping method

Type: bpy.props.EnumProperty

class NIMPHS_OpenfoamClipScalarProperty

Bases: PropertyGroup

Clip scalar settings.

invert: None

is_custom_base_cls = False

list: None

Save the list of available scalars

Type: bpy.props.StringProperty

register_cls = True

value: None

Set the clipping value

Type: bpy.props.FloatProperty

nimphs.properties.openfoam.file_data

class OpenfoamFileData(file_path: str, settings: Optional[NIMPHS_OpenfoamImportSettings])

Bases: FileData

Hold file data for the OpenFOAM module.

copy(other: OpenfoamFileData) → None

Copy important information from the given instance of file data.

Parameters: other (NIMPHS_OpenfoamFileData) -- OpenFOAM file data

get_point_data(id: Union[str, int]) → ndarray

Get point data from the given id.

Parameters: id (Union[str, int]) -- identifier of the variable from which to get data

get_point_data_from_raw(id: Union[str, int]) → ndarray

Force to get point data from the raw mesh.

Parameters: id (Union[str, int]) -- identifier of the variable from which to get data

init_point_data_manager() → None: Initialize point data manager (contains variables information).

is_ok() → bool

Check if file data is up (data are not None or empty).

Returns: True if ok
Return type: bool

load_file(file_path: str) → bool

Load an OpenFOAM file.

Parameters: file_path (str) -- path to the file to load
Returns: success
Return type: bool

mesh: PolyData = None

lest generated mesh

Type: PolyData

raw_mesh: UnstructuredGrid = None

'internalMesh' from data

Type: UnstructuredGrid

skip_zero_has_changed: bool = False

indicate if the skip_zero_time property has changed

Type: bool

tiangulate: bool = False

Indicate whether triangulation should be applied or not

Type: bool

time_point: int = 0

current time point

Type: int

update_data(time_point: int) → None

Update file data.

Parameters

time_point (int) -- time point to read
io_settings (Union[NIMPHS_OpenfoamImportSettings, None], optional) -- import settings. Defaults to None.

update_import_settings(settings: Optional[NIMPHS_OpenfoamImportSettings]) → None

Update import settings. If none provided, set default settings.

Parameters: settings (Union[NIMPHS_OpenfoamImportSettings, None]) -- OpenFOAM import settings

nimphs.properties.openfoam.import_settings

class NIMPHS_OpenfoamImportSettings

Bases: PropertyGroup

Import settings for the OpenFOAM module.

case_type: None

Indicate whether decomposed mesh or reconstructed mesh should be read

Type: bpy.props.EnumProperty

decompose_polyhedra: None

If True, decompose polyhedra into tetrahedra and pyramids

Type: bpy.props.BoolProperty

is_custom_base_cls = False

register_cls = True

skip_zero_time: None

If True, skip the '/0' time folder.

Type: bpy.props.BoolProperty

triangulate: None

If True, more complex polygons will be broken down into triangles

Type: bpy.props.BoolProperty

nimphs.properties.openfoam.openfoam_object_settings

class NIMPHS_OpenfoamObjectSettings

Bases: PropertyGroup

Data structure which holds object related settings for the OpenFOAM module.

clip: None

Clip settings.

Type: NIMPHS_OpenfoamClipProperty

import_settings: None

Import settings.

Type: NIMPHS_OpenfoamImportSettings

is_custom_base_cls = False

register_cls = True

s_sequence: None

OpenFOAM streaming sequence properties.

Type: NIMPHS_OpenfoamStreamingSequenceProperty

nimphs.properties.openfoam.openfoam_streaming_sequence

class NIMPHS_OpenfoamStreamingSequenceProperty

Bases: NIMPHS_ModuleStreamingSequenceSettings

'streaming sequence' settings for the OpenFOAM module.

is_custom_base_cls = False

register_cls = True