rizer.adaptive_models.contract

Quantities of interest targeted by the adaptive ladder.

Every stage solver and the modeling-error estimator agree on this vocabulary; validate_qoi() is the single gate a QoI set passes through before it reaches them. The stage-solver API itself lives on BasePhysicalModel.

Attributes

QOI_VOCABULARY
QoISet

Functions

validate_qoi(→ QoISet)

Validate a QoI set against QOI_VOCABULARY.

Module Contents

rizer.adaptive_models.contract.QOI_VOCABULARY

rizer.adaptive_models.contract.QoISet

rizer.adaptive_models.contract.validate_qoi(qoi: QoISet) → QoISet

Validate a QoI set against QOI_VOCABULARY.

Parameters:

qoi (tuple of str) – Names of the quantities of interest.

Returns:

The validated set, unchanged.

Return type:

tuple of str

Raises:

ValueError – If a name is not in the vocabulary.