NekUpload.NekData.filters module

class NekUpload.NekData.filters.AerodynamicForcesFilter(boundary: 'str', output_file: 'str', output_frequency: 'int' = 1, pivot_point: 'tuple[float, float, float]' = (0.0, 0.0, 0.0))

Bases: NekFilter

boundary: str

output_file: str

output_frequency: int = 1

pivot_point: tuple[float, float, float] = (0.0, 0.0, 0.0)

class NekUpload.NekData.filters.CheckpointFilter(output_frequency: 'int', output_file: 'str', output_start_time: 'float' = 0.0)

Bases: NekFilter

output_file: str

output_frequency: int

output_start_time: float = 0.0

class NekUpload.NekData.filters.HistoryPointsFilter(output_file: 'str', output_frequency: 'int' = 1, output_one_file: 'bool' = True, output_plane: 'int' = -1, wave_space: 'bool' = False, points: 'tuple[float, ...]' = (), line: 'tuple[float, ...]' = (), plane: 'tuple[float, ...]' = (), box: 'tuple[float, ...]' = ())

Bases: NekFilter

box: tuple[float, ...] = ()

line: tuple[float, ...] = ()

output_file: str

output_frequency: int = 1

output_one_file: bool = True

output_plane: int = -1

plane: tuple[float, ...] = ()

points: tuple[float, ...] = ()

wave_space: bool = False

class NekUpload.NekData.filters.NekFilter

Bases: ABC

output_file: str

class NekUpload.NekData.filters.NekFilterFactory

Bases: object

classmethod get_filter(name: str, params: dict[str, Any], session_file: str) → NekFilter | None

Get the Nektar filter

Parameters:

• name (str) – Name/Type of filter

• params (dict[str, Any]) – Parameters associated with this filter

• session_file (str) – Path or name of the sesison file

Returns:

NekFilter object

Return type:

NekFilter | None

NekUpload.NekData.filters.add_extension_if_needed(name: str, extension: str) → str

Only adds extension to the name if no extension exists.

Parameters:

• name (str) – _description_

• extension (str) – _description_

Returns:

_description_

Return type:

str