OOPS
oops::ModelParametersBase Class Reference

Base class for classes storing model-specific parameters. More...

#include <ModelBase.h>

Inheritance diagram for oops::ModelParametersBase:
Collaboration diagram for oops::ModelParametersBase:

Public Attributes

OptionalParameter< std::string > name {"name", this}
 Model name. More...
 

Detailed Description

Base class for classes storing model-specific parameters.

Definition at line 81 of file ModelBase.h.

Member Data Documentation

◆ name

OptionalParameter<std::string> oops::ModelParametersBase::name {"name", this}

Model name.

Note
This parameter is marked as optional because it is only required in certain circumstances (e.g. when model parameters are deserialized into a ModelParametersWrapper and used by ModelFactory to instantiate a model whose type is determined at runtime), but not others (e.g. in tests written with a particular model in mind). ModelParametersWrapper will throw an exception if this parameter is not provided.

Definition at line 91 of file ModelBase.h.


The documentation for this class was generated from the following file: