Class to parse a parameter list for sublists. More...

#include <LOCA_Parameter_SublistParser.H>

Public Member Functions
	SublistParser (const Teuchos::RCP< LOCA::GlobalData > &global_data)
	Constructor.
	~SublistParser ()
	Destructor.
void	parseSublists (const Teuchos::RCP< Teuchos::ParameterList > &topLevelParams)
	Parse parameter list to find sublists.
Teuchos::RCP< Teuchos::ParameterList >	getSublist (const std::string &name)
	Return sublist of name `name`.

Protected Attributes
Teuchos::RCP< LOCA::GlobalData >	globalData
	Global data.
SublistMap	sublistMap
	Map to hold sublists.

Detailed Description

Class to parse a parameter list for sublists.

This class parses a supplied parameter list and locates various sublists. This saves the code from having to traverse the parameter list to find sublists itself, and puts in one location the hard-coded structure of the parameter list.

Constructor & Destructor Documentation

◆ SublistParser()

LOCA::Parameter::SublistParser::SublistParser ( const Teuchos::RCP< LOCA::GlobalData > & global_data )

Constructor.

References globalData, and sublistMap.

Member Function Documentation

◆ getSublist()

Teuchos::RCP< Teuchos::ParameterList > LOCA::Parameter::SublistParser::getSublist ( const std::string & name )

Return sublist of name name.

References globalData, and sublistMap.

◆ parseSublists()

void LOCA::Parameter::SublistParser::parseSublists ( const Teuchos::RCP< Teuchos::ParameterList > & topLevelParams )

Parse parameter list to find sublists.

References sublistMap.

Member Data Documentation

◆ globalData

Teuchos::RCP<LOCA::GlobalData> LOCA::Parameter::SublistParser::globalData

protected

Global data.

Referenced by getSublist(), and SublistParser().

◆ sublistMap

SublistMap LOCA::Parameter::SublistParser::sublistMap

protected

Map to hold sublists.

Referenced by getSublist(), parseSublists(), and SublistParser().

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

LOCA_Parameter_SublistParser.H
LOCA_Parameter_SublistParser.C

Public Member Functions

Protected Attributes