Opm::parameter Namespace Reference

See ParameterGroup.hpp for how to use the parameter system. More...

Classes
class	Parameter
class	ParameterGroup
struct	ParameterMapItem
struct	ParameterMapItemTrait
struct	ParameterMapItemTrait< bool >
struct	ParameterMapItemTrait< double >
struct	ParameterMapItemTrait< int >
struct	ParameterMapItemTrait< ParameterGroup >
struct	ParameterMapItemTrait< std::string >
struct	ParameterRequirementAnd
struct	ParameterRequirementMemberOf
struct	ParameterRequirementNegative
struct	ParameterRequirementNone
struct	ParameterRequirementNonEmpty
struct	ParameterRequirementNonNegative
struct	ParameterRequirementNonPositive
struct	ParameterRequirementNonZero
struct	ParameterRequirementPositive
struct	ParameterRequirementProbability

Functions
std::string	correct_parameter_tag (const ParameterMapItem &item)
std::string	correct_type (const Parameter &parameter, const std::string &type)
std::pair< std::string, std::string >	split (const std::string &name)
void	fill_xml (ParameterGroup &pg, const std::string filename, const bool enable_output)
	This function fills a ParameterGroup with a XML file. More...

Variables
const std::string	ID_true = "true"
const std::string	ID_false = "false"
const std::string	ID_xmltag__param_grp = "ParameterGroup"
const std::string	ID_xmltag__param = "Parameter"
const std::string	ID_xmltag__file_param_grp = "ParameterGroupFromFile"
const std::string	ID_xmltag__file_params = "MergeWithFile"
const std::string	ID_xmlatt__value = "value"
const std::string	ID_xmlatt__name = "name"
const std::string	ID_xmlatt__type = "type"
const std::string	ID_param_type__bool = "bool"
const std::string	ID_param_type__int = "int"
const std::string	ID_param_type__float = "double"
const std::string	ID_param_type__string = "string"
const std::string	ID_param_type__file = "file"
const std::string	ID_param_type__cmdline = "cmdline"
const std::string	ID_path_root = ""
const std::string	ID_delimiter_path = "/"
const std::string	ID_comment = "//"
const std::string	ID_delimiter_assignment = "="

Detailed Description

See ParameterGroup.hpp for how to use the parameter system.

Function Documentation

std::string Opm::parameter::correct_parameter_tag

(

const ParameterMapItem &

item

)

Referenced by Opm::parameter::ParameterMapItemTrait< int >::convert(), Opm::parameter::ParameterMapItemTrait< double >::convert(), Opm::parameter::ParameterMapItemTrait< bool >::convert(), and Opm::parameter::ParameterMapItemTrait< std::string >::convert().

std::string Opm::parameter::correct_type	(	const Parameter &	parameter,
		const std::string &	type
	)

Referenced by Opm::parameter::ParameterMapItemTrait< int >::convert(), Opm::parameter::ParameterMapItemTrait< double >::convert(), Opm::parameter::ParameterMapItemTrait< bool >::convert(), and Opm::parameter::ParameterMapItemTrait< std::string >::convert().

void Opm::parameter::fill_xml	(	ParameterGroup &	pg,
		const std::string	filename,
		const bool	enable_output
	)

This function fills a ParameterGroup with a XML file.

NOTE: The function throws if there is an error during reading of the XML file.

Return values

pg	is the ParameterGroup to be filled.

Parameters

filename

is the name of an XML file.

std::pair<std::string, std::string> Opm::parameter::split

(

const std::string &

name

)

Referenced by Opm::Details::PhasePressure::assign(), Opm::parameter::ParameterGroup::get(), and Opm::parameter::ParameterGroup::getDefault().

Variable Documentation

const std::string Opm::parameter::ID_comment = "//"

const std::string Opm::parameter::ID_delimiter_assignment = "="

const std::string Opm::parameter::ID_delimiter_path = "/"

Referenced by Opm::parameter::ParameterGroup::get(), and Opm::parameter::ParameterGroup::getDefault().

const std::string Opm::parameter::ID_false = "false"

Referenced by Opm::parameter::ParameterMapItemTrait< bool >::convert(), and Opm::parameter::ParameterGroup::to_string().

const std::string Opm::parameter::ID_param_type__bool = "bool"

Referenced by Opm::parameter::ParameterMapItemTrait< bool >::convert(), and Opm::parameter::ParameterMapItemTrait< bool >::type().

const std::string Opm::parameter::ID_param_type__cmdline = "cmdline"

const std::string Opm::parameter::ID_param_type__file = "file"

const std::string Opm::parameter::ID_param_type__float = "double"

Referenced by Opm::parameter::ParameterMapItemTrait< double >::convert(), and Opm::parameter::ParameterMapItemTrait< double >::type().

const std::string Opm::parameter::ID_param_type__int = "int"

Referenced by Opm::parameter::ParameterMapItemTrait< int >::convert(), and Opm::parameter::ParameterMapItemTrait< int >::type().

const std::string Opm::parameter::ID_param_type__string = "string"

Referenced by Opm::parameter::ParameterMapItemTrait< std::string >::convert(), and Opm::parameter::ParameterMapItemTrait< std::string >::type().

const std::string Opm::parameter::ID_path_root = ""

const std::string Opm::parameter::ID_true = "true"

Referenced by Opm::parameter::ParameterMapItemTrait< bool >::convert(), and Opm::parameter::ParameterGroup::to_string().

const std::string Opm::parameter::ID_xmlatt__name = "name"

const std::string Opm::parameter::ID_xmlatt__type = "type"

const std::string Opm::parameter::ID_xmlatt__value = "value"

const std::string Opm::parameter::ID_xmltag__file_param_grp = "ParameterGroupFromFile"

const std::string Opm::parameter::ID_xmltag__file_params = "MergeWithFile"

const std::string Opm::parameter::ID_xmltag__param = "Parameter"

Referenced by Opm::parameter::Parameter::getTag().

const std::string Opm::parameter::ID_xmltag__param_grp = "ParameterGroup"

Referenced by Opm::parameter::ParameterMapItemTrait< ParameterGroup >::convert().