piglot.solver.links.fields.Reaction

class Reaction(field: str, group: int = 1)

Bases: OutputField

Reaction outputs reader.

Methods

check	Sanity checks on the input file.
get	Reads reactions from a Links analysis.
read	Read the output field from the configuration dictionary.

check(input_data: InputData) → None

Sanity checks on the input file.

This checks if: - we are reading the reactions of a macroscopic analysis; - the file has NODE_GROUPS outputs.

Parameters

input_dataInputData

Input data for this case.

Raises

RuntimeError

If not reading a macroscopic analysis file.

RuntimeError

If reaction output is not requested in the input file.

get(input_data: InputData) → OutputResult

Reads reactions from a Links analysis.

Parameters

input_dataInputData

Input data for this case.

Returns

array

2D array with load factor in the first column and reactions in the second.

classmethod read(config: Dict[str, Any]) → Reaction

Read the output field from the configuration dictionary.

Parameters

configDict[str, Any]

Configuration dictionary.

Returns

Reaction

Output field to use for this problem.