Class CheckingModelComponent¶
Defined in File CheckingModelComponent.hpp
Nested Relationships¶
Nested Types¶
Inheritance Relationships¶
Base Type¶
public Nextsim::ModelComponent(Class ModelComponent)
Derived Type¶
public Nextsim::PrognosticData(Class PrognosticData)
Class Documentation¶
-
class CheckingModelComponent : public Nextsim::ModelComponent¶
Subclassed by Nextsim::PrognosticData
Protected Functions
-
CheckingModelComponent() = default¶
-
inline void checkFields() const¶
Check fields listed in fieldsToCheck. Throw a runtime_error if values are outside bounds.
-
inline void addChecks(const std::map<const std::string, ModelArrayAccessorBase<RO>> &fieldsToAdd)¶
Add all the fields listed to the vector fieldsToCheck so they will be checked by checkFields()
- Parameters:
fieldsToAdd – An std::map of string-s and ModelArrayAccessors-s with field names and references to check.
Protected Attributes
-
bool checkFast = false¶
- Param checkFast:
Set to true to do a quick check of the main prognostics in PrognosticData
Protected Static Functions
-
static inline bool &checkAll()¶
- Parameters:
checkAll – Set to true to do an exhaustive check of all the variable registered in the central registry and any additional variable registered by the modules.
-
CheckingModelComponent() = default¶