Classes
class	DataContext

class	DataFileContext

class	Group

class	GroupContext

class	CatalogInterface
	This class provides the base class/interface for the catalog value objects. More...

class	CatalogEntry
	Class to hold allocation capability for specific target derived types. More...

class	CatalogEntryConstructor
	A class to generate the catalog entry. More...

class	CatalogInterface< BASETYPE >
	Specialization of `CatalogInterface` for types with no-argument constructors/. More...

class	CatalogEntry< BASETYPE, TYPE >
	Specialization of `CatalogEntry` for types with no-argument constructors. More...

class	CatalogEntryConstructor< BASETYPE, TYPE >
	A specialization of `CatalogEntryConstructor` for types with no-argument constructors. More...

class	Wrapper

class	WrapperBase
	Base class for all wrappers containing common operations. More...

class	WrapperContext

Typedefs
template<typename T >
using	DefaultValue = internal::Helper< T >
	A templated alias to hold default values. More...

using	keyType = string
	The default key type for entries in the hierarchy.

using	indexType = localIndex
	The default index type for entries the hierarchy.

using	GroupKey = Group::subGroupMap::KeyIndex
	Type alias for KeyIndexT type used for sub-group lookups.

using	ViewKey = Group::wrapperMap::KeyIndex
	Type alias for KeyIndexT type used for wrapper lookups.

Enumerations
enum class	InputFlags : integer { INVALID , FALSE , OPTIONAL , OPTIONAL_NONUNIQUE , REQUIRED , REQUIRED_NONUNIQUE , PROBLEM_ROOT }

enum class	RestartFlags : integer { NO_WRITE , WRITE , WRITE_AND_READ }

enum class	PlotLevel : integer { LEVEL_0 , LEVEL_1 , LEVEL_2 , LEVEL_3 , NOPLOT }

Functions
InputFlags	IntToInputFlag (int const val)
	Convert integer value to InputFlags. More...

int	InputFlagToInt (InputFlags const val)
	Convert InputFlags to int. More...

string	InputFlagToString (InputFlags const val)
	Convert an InputFlags value to a string. More...

bool	operator== (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator!= (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator< (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator> (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator<= (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

bool	operator>= (InputFlags const left, InputFlags const right)
	Comparison operator for InputFlags enumeration. More...

PlotLevel	toPlotLevel (int const val)
	Function to get a PlotLevel enum from an int. More...

std::istream &	operator>> (std::istream &is, PlotLevel &plotLevel)
	Reads a PlotLevel enum from a stream. More...

std::ostream &	operator<< (std::ostream &os, PlotLevel const &plotLevel)
	Writes a plot level to a stream. More...

void	printMemoryAllocation (Group const &group, integer const indent, real64 const threshold)
	Prints the memory allocations for a group in the data repository recursively. More...

Detailed Description

Encapsulates all dataRepository classes and functionality.

Typedef Documentation

◆ DefaultValue

template<typename T >

using geos::dataRepository::DefaultValue = typedef internal::Helper< T >

A templated alias to hold default values.

Template Parameters

T	the type to check

Definition at line 134 of file DefaultValue.hpp.

Enumeration Type Documentation

◆ InputFlags

enum geos::dataRepository::InputFlags : integer

strong

Enumeration of flags that control reading XML input and schema generation.

Enumerator
INVALID	Invalid value.
FALSE	Not read from input.
OPTIONAL	Optional in input.
OPTIONAL_NONUNIQUE	Optional in input, may be repeated.
REQUIRED	Required in input.
REQUIRED_NONUNIQUE	Required in input, may be repeated.
PROBLEM_ROOT	Root of the hierarchy.

Definition at line 37 of file InputFlags.hpp.

◆ PlotLevel

enum geos::dataRepository::PlotLevel : integer

strong

A scoped enum for the Plot options.

Enumerator
LEVEL_0	Write to plot always.
LEVEL_1	Write to plot when plotLevel>=1 is specified in input.
LEVEL_2	Write to plot when plotLevel>=2 is specified in input.
LEVEL_3	Write to plot when plotLevel>=3 is specified in input.
NOPLOT	Do not ever write to plot file.

Definition at line 47 of file RestartFlags.hpp.

◆ RestartFlags

enum geos::dataRepository::RestartFlags : integer

strong

A scoped enum for the restart options.

Enumerator
NO_WRITE	Do not write into restart.
WRITE	Write into restart.
WRITE_AND_READ	Write and read from restart.

Definition at line 35 of file RestartFlags.hpp.

Function Documentation

◆ InputFlagToInt()

int geos::dataRepository::InputFlagToInt ( InputFlags const val )

inline

Convert InputFlags to int.

Parameters

[in] val value to convert

Returns: converted integer

Definition at line 86 of file InputFlags.hpp.

◆ InputFlagToString()

string geos::dataRepository::InputFlagToString ( InputFlags const val )

inline

Convert an InputFlags value to a string.

Parameters

[in] val The value of the input flag that will be converted to a string

Returns: The string equivalent of the input val.

Definition at line 97 of file InputFlags.hpp.

◆ IntToInputFlag()

InputFlags geos::dataRepository::IntToInputFlag ( int const val )

inline

Convert integer value to InputFlags.

Parameters

[in] val value to convert

Returns: converted enumeration

Definition at line 53 of file InputFlags.hpp.

◆ operator!=()

bool geos::dataRepository::operator!=	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 155 of file InputFlags.hpp.

◆ operator<()

bool geos::dataRepository::operator<	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 163 of file InputFlags.hpp.

◆ operator<<()

std::ostream& geos::dataRepository::operator<<	(	std::ostream &	os,
		PlotLevel const &	plotLevel
	)

inline

Writes a plot level to a stream.

Parameters

os	The stream to read from.
plotLevel	the PlotLevel to write.

Returns: The stream.

Definition at line 115 of file RestartFlags.hpp.

◆ operator<=()

bool geos::dataRepository::operator<=	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 179 of file InputFlags.hpp.

◆ operator==()

bool geos::dataRepository::operator==	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 147 of file InputFlags.hpp.

◆ operator>()

bool geos::dataRepository::operator>	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 171 of file InputFlags.hpp.

◆ operator>=()

bool geos::dataRepository::operator>=	(	InputFlags const	left,
		InputFlags const	right
	)

inline

Comparison operator for InputFlags enumeration.

Parameters

left	lhs value
right	rhs value

Returns: comparison result

Definition at line 187 of file InputFlags.hpp.

◆ operator>>()

std::istream& geos::dataRepository::operator>>	(	std::istream &	is,
		PlotLevel &	plotLevel
	)

inline

Reads a PlotLevel enum from a stream.

Parameters

is	The stream to read from.
plotLevel	The PlotLevel to write to.

Returns: The stream.

Definition at line 100 of file RestartFlags.hpp.

◆ printMemoryAllocation()

void geos::dataRepository::printMemoryAllocation	(	Group const &	group,
		integer const	indent,
		real64 const	threshold
	)

Prints the memory allocations for a group in the data repository recursively.

Parameters

	group	The group to print
[in]	indent	The level of indentation to add to this level of output.
[in]	threshold	The allocation size required to output a allocation size.

◆ toPlotLevel()

PlotLevel geos::dataRepository::toPlotLevel ( int const val )

inline

Function to get a PlotLevel enum from an int.

Parameters

val	int that represents the PlotLevel

Returns: The PlotLevel that corresponds to the input

Definition at line 61 of file RestartFlags.hpp.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ DefaultValue

Enumeration Type Documentation

◆ InputFlags

◆ PlotLevel

◆ RestartFlags

Function Documentation

◆ InputFlagToInt()

◆ InputFlagToString()

◆ IntToInputFlag()

◆ operator!=()

◆ operator<()

◆ operator<<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator>>()

◆ printMemoryAllocation()

◆ toPlotLevel()