nimphs.operators.openfoam

Modules

nimphs.operators.openfoam.openfoam_create_mesh_sequence

class NIMPHS_OT_OpenfoamCreateMeshSequence

Bases: NIMPHS_CreateMeshSequence

Create an OpenFOAM 'mesh sequence'.

bl_description: Union[str, Any] = "Create mesh a sequence. Press 'esc' to cancel"

typing.Union[str, typing.Any]

Type: type

bl_idname: Union[str, Any] = 'nimphs.openfoam_create_mesh_sequence'

typing.Union[str, typing.Any]

Type: type

bl_label: Union[str, Any] = 'Mesh sequence'

typing.Union[str, typing.Any]

Type: type

clip: None

clip settings

Type: NIMPHS_OpenfoamImportSettings

draw(context: Context) → None

UI layout of the popup window.

Parameters: context (Context) -- context

import_settings: None

import settings

Type: NIMPHS_OpenfoamImportSettings

invoke(context: Context, _event: Event) → set

Prepare operator settings. Function triggered before the user can edit settings.

Parameters

context (Context) -- context
_event (Event) -- event

Returns

state of the operator

Return type

set

is_custom_base_cls = False

classmethod poll(context: Context) → bool

If false, locks the button of the operator.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: bool

register_cls = True

run_one_step(context: Context) → set

Run one step of the 'create mesh sequence' process.

Parameters: context (Context) -- context
Returns: state of the operator. Enum in ['PASS_THROUGH', 'CANCELLED'].
Return type: set

nimphs.operators.openfoam.openfoam_create_streaming_sequence

class NIMPHS_OT_OpenfoamCreateStreamingSequence

Bases: NIMPHS_CreateStreamingSequence

Create an OpenFOAM 'streaming sequence'.

bl_description: Union[str, Any] = "Create a 'streaming sequence'"

typing.Union[str, typing.Any]

Type: type

bl_idname: Union[str, Any] = 'nimphs.openfoam_create_streaming_sequence'

typing.Union[str, typing.Any]

Type: type

bl_label: Union[str, Any] = 'Streaming sequence'

typing.Union[str, typing.Any]

Type: type

draw(context: Context) → None

UI layout of the popup window.

Parameters: context (Context) -- context

execute(context: Context) → set

Generate the 'streaming sequence' object.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: set

invoke(context: Context, _event: Event) → set

Prepare operator settings. Function triggered before the user can edit settings.

Parameters

context (Context) -- context
_event (Event) -- event

Returns

state of the operator

Return type

set

is_custom_base_cls = False

classmethod poll(context: Context) → bool

If false, locks the button of the operator.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: bool

register_cls = True

nimphs.operators.openfoam.openfoam_import_file

class NIMPHS_OT_OpenfoamImportFile

Bases: Operator, ImportHelper

Import an OpenFOAM file.

bl_description: Union[str, Any] = 'Import an OpenFOAM file'

typing.Union[str, typing.Any]

Type: type

bl_idname: Union[str, Any] = 'nimphs.import_openfoam_file'

typing.Union[str, typing.Any]

Type: type

bl_label: Union[str, Any] = 'Import'

typing.Union[str, typing.Any]

Type: type

draw(_context: Context) → None

UI layout of the operator.

Parameters: _context (Context) -- context

execute(context: Context) → set

Import the selected file. Generates a preview object.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: set

filter_glob: None

List of allowed file extensions.

Type: bpy.props.StringProperty

import_settings: None

Import settings.

Type: NIMPHS_OpenfoamImportSettings

is_custom_base_cls = False

mode: None

Indicate which mode to use for this operator. Enum in ['NORMAL', 'TEST'].

Type: bpy.props.EnumProperty

register_cls = True

setup_generated_obj(context: Context, obj: Object, file_data: OpenfoamFileData) → None

Copy import settings and setup needed 'nimphs' data for the generated object.

Parameters

context (Context) -- context
obj (Object) -- generated object
file_data (NIMPHS_OpenfoamFileData) -- OpenFOAM file data

import_openfoam_menu_draw(self, context: Context) → None

Draw function which displays the import button in File > Import.

Parameters: context (Context) -- context

nimphs.operators.openfoam.openfoam_preview

class NIMPHS_OT_OpenfoamPreview

Bases: Operator

Operator to generate a preview of an OpenFOAM object.

bl_description: Union[str, Any] = 'Preview the selected object'

typing.Union[str, typing.Any]

Type: type

bl_idname: Union[str, Any] = 'nimphs.openfoam_preview'

typing.Union[str, typing.Any]

Type: type

bl_label: Union[str, Any] = 'Preview'

typing.Union[str, typing.Any]

Type: type

execute(context: Context) → set

Generate a preview of the selected object.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: set

is_custom_base_cls = False

mode: None

Indicate which mode to use for this operator. Enum in ['NORMAL', 'TEST'].

Type: bpy.props.EnumProperty

classmethod poll(context: Context) → bool

Check if the operator can run.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: set

register_cls = True

nimphs.operators.openfoam.openfoam_reload_file

class NIMPHS_OT_OpenfoamReloadFile

Bases: Operator

Operator to reload file data of the selected OpenFOAM object.

bl_description: Union[str, Any] = 'Reload file data of the selected OpenFOAM object'

typing.Union[str, typing.Any]

Type: type

bl_idname: Union[str, Any] = 'nimphs.reload_openfoam_file'

typing.Union[str, typing.Any]

Type: type

bl_label: Union[str, Any] = 'Reload'

typing.Union[str, typing.Any]

Type: type

execute(context: Context) → set

Reload file data of the selected OpenFOAM object.

Parameters: context (Context) -- context
Returns: state of the operator
Return type: set

is_custom_base_cls = False

mode: None

Indicate which mode to use for this operator. Enum in ['NORMAL', 'TEST'].

Type: bpy.props.EnumProperty

register_cls = True