axom::bump::Options Class Reference

This class provides a kind of schema over options, as well as default values, and some utilities functions. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/bump/Options.hpp>

Public Member Functions
	Options (const conduit::Node &options)
	Constructor. More...
std::string	topologyName (const std::string &default_value=std::string()) const
	Return the name of the topology to make in the output. More...
std::string	coordsetName (const std::string &default_value=std::string()) const
	Return the name of the coordset to make in the output. More...
std::string	originalElementsField () const
	Return the name of the originalElements field. return The name of the originalElements field. More...
bool	fields (std::map< std::string, std::string > &f) const
	Extract the names of the fields to process (and their output names) from the options or n_fields if the options do not contain fields. More...
const conduit::Node &	options () const
	Return the options node reference. More...
std::string	matset () const
	Get the name of the matset on which we'll operate. More...
std::string	matsetName (const std::string &default_value=std::string()) const
	Return the name of the matset to make in the output. More...

Protected Attributes
const conduit::Node &	m_options

Detailed Description

This class provides a kind of schema over options, as well as default values, and some utilities functions.

Constructor & Destructor Documentation

Options()

axom::bump::Options::Options ( const conduit::Node &  options )

inline

Constructor.

Parameters

nzones	The total number of zones in the associated topology.
options	The node that contains the options.

Member Function Documentation

topologyName()

std::string axom::bump::Options::topologyName ( const std::string &  default_value = std::string() ) const

inline

Return the name of the topology to make in the output.

Parameters

default_value

The name to use if the option is not defined.

Returns

The name of the topology to make in the output.

References m_options.

coordsetName()

std::string axom::bump::Options::coordsetName ( const std::string &  default_value = std::string() ) const

inline

Return the name of the coordset to make in the output.

Parameters

default_value

The name to use if the option is not defined.

Returns

The name of the coordset to make in the output.

References m_options.

originalElementsField()

std::string axom::bump::Options::originalElementsField ( ) const

inline

Return the name of the originalElements field. return The name of the originalElements field.

References m_options.

fields()

bool axom::bump::Options::fields ( std::map< std::string, std::string > &  f ) const

inline

Extract the names of the fields to process (and their output names) from the options or n_fields if the options do not contain fields.

Parameters

[out]

f

A map of the fields that will be processed, as well as their output name in the new fields.

Returns

True if the fields were present in the options. False otherwise.

References m_options.

options()

const conduit::Node& axom::bump::Options::options ( ) const

inline

Return the options node reference.

Returns

The options node reference.

References m_options.

matset()

std::string axom::bump::Options::matset ( ) const

inline

Get the name of the matset on which we'll operate.

Returns

The name of the matset.

References options().

matsetName()

std::string axom::bump::Options::matsetName ( const std::string &  default_value = std::string() ) const

inline

Return the name of the matset to make in the output.

Parameters

default_value

The name to use if the option is not defined.

Returns

The name of the matset to make in the output.

References matset(), and options().

Member Data Documentation

m_options

const conduit::Node& axom::bump::Options::m_options

protected

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/bump/Options.hpp