Class InputParameters

Inheritance Relationships

Base Type

Class Documentation

class InputParameters : public opensn::ParameterBlock

Class for handling input parameters.

Public Functions

InputParameters() = default
InputParameters &operator+=(InputParameters other)
void SetObjectType(const std::string &obj_type)

Sets the object type string for more descriptive error messages.

std::string GetObjectType() const

Returns the object type string.

std::string GetParameterDocString(const std::string &param_name)

Returns the parameter’s doc string.

template<typename T>
inline void AddOptionalParameter(const std::string &name, T value, const std::string &doc_string)
void AddOptionalParameterBlock(const std::string &name, const ParameterBlock &block, const std::string &doc_string)

Specialization for block type parameters.

template<typename T>
inline void AddOptionalParameterArray(const std::string &name, const std::vector<T> &array, const std::string &doc_string)
void AddOptionalParameterArray(const std::string &name, const std::vector<ParameterBlock> &array, const std::string &doc_string)

Specialization for block type parameters.

template<typename T>
inline void AddRequiredParameter(const std::string &name, const std::string &doc_string)
void AddRequiredParameterBlock(const std::string &name, const std::string &doc_string)

Specialization for block type parameters.

void AddRequiredParameterArray(const std::string &name, const std::string &doc_string)

Specialization for array type parameters.

template<typename T>
inline void ChangeExistingParamToOptional(const std::string &name, T value, const std::string &doc_string = "")
template<typename T>
inline void ChangeExistingParamToRequired(const std::string &name, const std::string &doc_string = "")
void AssignParameters(const ParameterBlock &params)

Assigns parameters with thorough type checks, deprecation checks, unused parameter checks.

inline const ParameterBlock &GetParametersAtAssignment() const

Returns the raw parameter block used at assignment.

This can be used to see if a user supplied an optional parameter or not.

bool IsParameterValid(const std::string &param_name) const
void MarkParameterDeprecatedWarning(const std::string &param_name, const std::string &deprecation_message = "")

Marks a parameters as deprecated but will only produce a warning.

void MarkParameterDeprecatedError(const std::string &param_name, const std::string &deprecation_message = "")

Marks a parameters as deprecated and will produce an error if the parameter is specified.

void MarkParameterRenamed(const std::string &param_name, const std::string &renaming_description)

Marks a parameters as renamed and will produce an error if the parameter is specified.

void ConstrainParameterRange(const std::string &param_name, std::shared_ptr<AllowableRange> allowable_range)

Creates a range based constraint for a given parameter.

void SetParameterTypeMismatchAllowed(const std::string &param_name)

Sets a tag for the given parameter that will allow its type to be mismatched upon assignment.