The validation.py module#

Summary#

validate_chemid

Validate Chemistry set index.

validate_temperature

Validate gas temperature.

validate_pressure_temperature

Validate pressure and temperature pair.

validate_density

Validate density value.

validate_fraction_arrays

Validate fraction and molecular-weight arrays are same size.

validate_species_array_size

Validate a species-array size against expected species count.

validate_minimum_value

Validate that a scalar value is greater than or equal to a minimum.

validate_equal_list_lengths

Validate that two list lengths are equal.

validate_fraction_array_size

Validate fractions-array size against chemistry species count.

validate_file_exists

Validate that a filesystem path points to an existing file.

Description#

Reusable validation helpers for core modules.

Module detail#

validation.validate_chemid(chemid: int) None#

Validate Chemistry set index.

validation.validate_temperature(temp: float) None#

Validate gas temperature.

validation.validate_pressure_temperature(pressure: float, temp: float) None#

Validate pressure and temperature pair.

validation.validate_density(density: float) None#

Validate density value.

validation.validate_fraction_arrays(frac, wt, mode: str) int#

Validate fraction and molecular-weight arrays are same size.

validation.validate_species_array_size(expected: int, actual: int, context: str) None#

Validate a species-array size against expected species count.

validation.validate_minimum_value(value: float, minimum: float, message: str) None#

Validate that a scalar value is greater than or equal to a minimum.

validation.validate_equal_list_lengths(first_label: str, first_len: int, second_label: str, second_len: int) None#

Validate that two list lengths are equal.

validation.validate_fraction_array_size(actual: int, expected: int) None#

Validate fractions-array size against chemistry species count.

validation.validate_file_exists(file_path: str, context_label: str = 'file') None#

Validate that a filesystem path points to an existing file.