NekUpload.validate.session module

class NekUpload.validate.session.ValidateSession(file_path: str)[source]

Bases: object

Class responsible for validation session files

check_boundary_condition_schema(boundary_condition_files: list[str]) bool[source]

Identifies boundary condition files, and checks against schema

Parameters:

boundary_condition_files (list[str]) – INput files

Returns:

Valid

Return type:

bool

check_boundary_conditions_reference(boundary_condition_files: list[str]) bool[source]

Checks whetehr all files referenced in BOUNDARYCONDITION in session file are present in the input list

Parameters:

boundary_condition_files (list[str]) – Input file list

Raises:

SessionFileException – _description_

Returns:

Valid

Return type:

bool

check_boundary_definition(geometry_file: str) bool[source]

Check that all boundaries defined in session file are present in the geometry file

Parameters:

geometry_file (str) – Geometry nekg file

Returns:

Valid if all boundaries in geometry files are defined in nekg file

Return type:

bool

check_checkpoint_files(checkpoint_files: list[str]) bool[source]
check_consistent_output_shape(geometry_file: str, output_file: str, solver: SolverType, field_count: int = 0) tuple[bool, list[str]][source]
check_expansion_definition(geometry_file: str) bool[source]

Check whether expansion definition reference the composite objects defined in the geometry file

Parameters:

geometry_file (str) – Path to geometry nekg file

Returns:

Valid

Return type:

True

check_filter_files_reference(file_list: list[str]) bool[source]
check_function_reference(function_file_list: list[str]) bool[source]

Checks whetehr all files referenced in FUNCTION in session file are present in the input list

Parameters:

function_file_list (list[str]) – Input file list

Raises:

SessionFileException – _description_

Returns:

Valid

Return type:

bool

check_geometry_file_reference(geometry_file: str) bool[source]

Check whether the geometry file provided is the one referencedd by the session file

Parameters:

geometry_file (str) – Geometry file name

Raises:

SessionFileException – _description_

Returns:

Valid

Return type:

bool

check_schema() bool[source]

Check file conforms to XML session schema

Returns:

Passed

Return type:

bool

get_checkpoint_filter_filenames() list[str][source]
is_valid_xml(xml_file: str, schema_file_path: str) bool[source]

Checks whether XML file conforms to a schema

Parameters:
  • xml_file (str) – XML file path

  • schema_file_path (str) – XSD schema file path

Raises:

XMLSchemaException – _description_

Returns:

Passed

Return type:

bool