piglot.solver.input_file_solver.OutputField

class OutputField[source]

Bases: ABC

Generic class for output fields.

Methods

check

Check for validity in the input data before reading.

get

Read the output data from the simulation.

read

Read the output field from the configuration dictionary.

abstract check(input_data: InputData) None[source]

Check for validity in the input data before reading.

Parameters

input_dataInputData

Input data to check for.

abstract get(input_data: InputData) OutputResult[source]

Read the output data from the simulation.

Parameters

input_dataInputData

Input data to check for.

Returns

OutputResult

Output result for this field.

abstract classmethod read(config: Dict[str, Any]) T[source]

Read the output field from the configuration dictionary.

Parameters

configDict[str, Any]

Configuration dictionary.

Returns

OutputField

Output field to use for this problem.