Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | List of all members
alsfvm::init::Parameters Class Reference

#include <alsfvm/init/Parameters.hpp>

Public Member Functions

void addParameter (const std::string &name, const std::vector< real > &value)
 Add a a parameter to the parameters. More...
 
std::vector< std::string > getParameterNames () const
 
const std::vector< real > & getParameter (const std::string &name) const
 
void setOrAddParameter (const std::string &name, const std::vector< real > &value)
 

Detailed Description

Parameters for the initial data. These are typically used to give random inputs.

Member Function Documentation

◆ addParameter()

void alsfvm::init::Parameters::addParameter ( const std::string &  name,
const std::vector< real > &  value 
)

Add a a parameter to the parameters.

◆ getParameter()

const std::vector< real > & alsfvm::init::Parameters::getParameter ( const std::string &  name) const

Each parameter is represented by an array A scalar is then represented by a length one array.

◆ getParameterNames()

std::vector< std::string > alsfvm::init::Parameters::getParameterNames ( ) const

◆ setOrAddParameter()

void alsfvm::init::Parameters::setOrAddParameter ( const std::string &  name,
const std::vector< real > &  value 
)

If the parameters doesn't exists, addParameter is called, otherwise, the parameter is overwritten.

Parameters
namethe name of the parameter
valuethe value of the parameter

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