nimphs.properties.telemac

Modules

nimphs.properties.telemac.file_data

class TelemacFileData(file_path: str)

Bases: FileData

Hold file data for the TELEMAC module.

copy(other: TelemacFileData) → None

Copy important information from the given instance of file data.

Parameters: other (NIMPHS_TelemacFileData) -- TELEMAC file data

data: np.ndarray = None

Data

Type: np.ndarray

dimensions: tuple[float, float, float] = (0.0, 0.0, 0.0)

Dimensions

Type: tuple[float, float, float]

faces: np.ndarray = None

Faces of the mesh

Type: np.ndarray

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_list(names: list[str]) → tuple[numpy.ndarray, str]

Check for every variable name and return data associated to the first occurrence.

Parameters: names (list[str]) -- list of possible variables
Returns: data, name of the variable
Return type: tuple[np.ndarray, str]

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

is_3d() → bool

Indicate if the file is from a 3D simulation.

Returns: state
Return type: bool

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 TELEMAC (Serafin) file.

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

nb_planes: int = 0

Number of planes

Type: int

nb_triangles: int = 0

Number of triangles

Type: int

nb_vertices: int = 0

Number of vertices

Type: int

update_data(time_point: int) → None

Update file data.

Parameters: time_point (int) -- time point to read

vertices: np.ndarray = None

Vertices of the mesh

Type: np.ndarray

remove_spaces(name: str)

Remove spaces at the end of the variable name (if the 16 characters are not used).

Parameters: string (str) -- input string
Returns: name
Return type: str

nimphs.properties.telemac.import_settings

class NIMPHS_TelemacImportSettings

Bases: PropertyGroup

Import settings for the TELEMAC module.

is_custom_base_cls = False

register_cls = True

nimphs.properties.telemac.interpolate

class NIMPHS_TelemacInterpolateProperty

Bases: PropertyGroup

Interpolation settings for the TELEMAC module.

is_custom_base_cls = False

register_cls = True

steps: None

Number of data to generate between two known data points

Type: bpy.props.IntProperty

type: None

Type of the interpolation. Enum in ['NONE', 'LINEAR']

Type: bpy.props.EnumProperty

nimphs.properties.telemac.telemac_mesh_sequence

class NIMPHS_TelemacMeshSequenceProperty

Bases: PropertyGroup

'mesh sequence' settings for the TELEMAC module.

is_custom_base_cls = False

register_cls = True

nimphs.properties.telemac.telemac_object_settings

class NIMPHS_TelemacObjectSettings

Bases: PropertyGroup

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

interpolate: None

Interpolation settings.

Type: bpy.props.NIMPHS_TelemacInterpolateProperty

is_custom_base_cls = False

m_sequence: None

TELEMAC 'mesh sequence' properties.

Type: NIMPHS_TelemacMeshSequenceProperty

register_cls = True

s_sequence: None

TELEMAC 'streaming sequence' properties.

Type: NIMPHS_TelemacStreamingSequenceProperty

z_name: None

Name of the variable used for the 'z-values' of the vertices.

Type: bpy.props.StringProperty

nimphs.properties.telemac.telemac_streaming_sequence

class NIMPHS_TelemacStreamingSequenceProperty

Bases: NIMPHS_ModuleStreamingSequenceSettings

'streaming sequence' settings for the TELEMAC module.

is_custom_base_cls = False

register_cls = True