panzer::GatherSolution_Input Class Reference

#include <Panzer_GatherSolution_Input.hpp>

Inherits ParameterListAcceptorDefaultBase.

Public Member Functions
	GatherSolution_Input ()
void	setParameterList (const Teuchos::ParameterList &pl)
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)
Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const
	Get valid parameters. More...
const std::vector< std::string > &	getDofNames () const
	The names of the DOFs to be gathered (all types) More...
const std::vector< std::string > &	getIndexerNames () const
Teuchos::RCP< const PureBasis >	getBasis () const
	Basis definiting layout of dof names (all types) More...
bool	useTimeDerivativeSolutionVector () const
	Gather a time derivative vector? (all types) More...
std::string	getGlobalDataKey () const
	Name of the global evaluation data container to use for the source vector (all types) More...
const std::vector< std::vector< std::string > > &	getTangentNames () const
	Get the name of the tangent fields (tangent only) More...
std::string	getSensitivitiesName () const
	The name of the sensitivities. Enables sensitivities at "preEvaluate" time (Jacobian and Hessian) More...
int	getGatherSeedIndex () const
	What index to use for initializing the seed (Jacobian and Hessian) More...
bool	firstSensitivitiesAvailable ()
	Are first derivative sensitivities enabled or disabled? (Jacobian and Hessian) More...
bool	secondSensitivitiesAvailable ()
	Are second derivative sensitivies enabled or disabled (Hessian only) More...
std::string	getSecondSensitivityDataKeyPrefix ()
	What prefix to use for the GEDC for second derivative sensitivity direction (Hessian only) More...

Private Member Functions
	GatherSolution_Input (const GatherSolution_Input &)

Private Attributes
std::vector< std::string >	dofNames_
std::vector< std::string >	indexerNames_
Teuchos::RCP< const PureBasis >	basis_
bool	useTimeDerivSolnVec_
std::string	globalDataKey_
std::vector< std::vector< std::string > >	tangentNames_
std::string	sensName_
int	gatherSeedIndex_
bool	firstSensAvail_
bool	secondSensAvail_
std::string	secondSensDataKeyPrefix_

Detailed Description

This class parses the input parameters for the gather solution evaluators. Its goal is to unify the input for all of those evaluators.

Definition at line 62 of file Panzer_GatherSolution_Input.hpp.

Constructor & Destructor Documentation

GatherSolution_Input() [1/2]

panzer::GatherSolution_Input::GatherSolution_Input

(

)

Definition at line 6 of file Panzer_GatherSolution_Input.cpp.

GatherSolution_Input() [2/2]

panzer::GatherSolution_Input::GatherSolution_Input ( const GatherSolution_Input &  )

private

Member Function Documentation

setParameterList() [1/2]

void panzer::GatherSolution_Input::setParameterList

(

const Teuchos::ParameterList &

pl

)

Set the parameter list, this is the complete state. This will modify the list.

Definition at line 13 of file Panzer_GatherSolution_Input.cpp.

setParameterList() [2/2]

void panzer::GatherSolution_Input::setParameterList

(

const Teuchos::RCP< Teuchos::ParameterList > &

pl

)

Set the parameter list, this is the complete state. This will modify the list.

Definition at line 20 of file Panzer_GatherSolution_Input.cpp.

getValidParameters()

Teuchos::RCP< const Teuchos::ParameterList > panzer::GatherSolution_Input::getValidParameters

(

)

const

Get valid parameters.

Definition at line 58 of file Panzer_GatherSolution_Input.cpp.

getDofNames()

const std::vector<std::string>& panzer::GatherSolution_Input::getDofNames ( ) const

inline

The names of the DOFs to be gathered (all types)

Definition at line 82 of file Panzer_GatherSolution_Input.hpp.

getIndexerNames()

const std::vector<std::string>& panzer::GatherSolution_Input::getIndexerNames ( ) const

inline

The indexer names used to gather the DOFs. Will be same length as getDofNames (all types).

Definition at line 87 of file Panzer_GatherSolution_Input.hpp.

getBasis()

Teuchos::RCP<const PureBasis> panzer::GatherSolution_Input::getBasis ( ) const

inline

Basis definiting layout of dof names (all types)

Definition at line 90 of file Panzer_GatherSolution_Input.hpp.

useTimeDerivativeSolutionVector()

bool panzer::GatherSolution_Input::useTimeDerivativeSolutionVector ( ) const

inline

Gather a time derivative vector? (all types)

Definition at line 93 of file Panzer_GatherSolution_Input.hpp.

getGlobalDataKey()

std::string panzer::GatherSolution_Input::getGlobalDataKey ( ) const

inline

Name of the global evaluation data container to use for the source vector (all types)

Definition at line 96 of file Panzer_GatherSolution_Input.hpp.

getTangentNames()

const std::vector<std::vector<std::string> >& panzer::GatherSolution_Input::getTangentNames ( ) const

inline

Get the name of the tangent fields (tangent only)

Definition at line 101 of file Panzer_GatherSolution_Input.hpp.

getSensitivitiesName()

std::string panzer::GatherSolution_Input::getSensitivitiesName ( ) const

inline

The name of the sensitivities. Enables sensitivities at "preEvaluate" time (Jacobian and Hessian)

Definition at line 106 of file Panzer_GatherSolution_Input.hpp.

getGatherSeedIndex()

int panzer::GatherSolution_Input::getGatherSeedIndex ( ) const

inline

What index to use for initializing the seed (Jacobian and Hessian)

Definition at line 109 of file Panzer_GatherSolution_Input.hpp.

firstSensitivitiesAvailable()

bool panzer::GatherSolution_Input::firstSensitivitiesAvailable ( )

inline

Are first derivative sensitivities enabled or disabled? (Jacobian and Hessian)

Definition at line 112 of file Panzer_GatherSolution_Input.hpp.

secondSensitivitiesAvailable()

bool panzer::GatherSolution_Input::secondSensitivitiesAvailable ( )

inline

Are second derivative sensitivies enabled or disabled (Hessian only)

Definition at line 117 of file Panzer_GatherSolution_Input.hpp.

getSecondSensitivityDataKeyPrefix()

std::string panzer::GatherSolution_Input::getSecondSensitivityDataKeyPrefix ( )

inline

What prefix to use for the GEDC for second derivative sensitivity direction (Hessian only)

Definition at line 120 of file Panzer_GatherSolution_Input.hpp.

Member Data Documentation

dofNames_

std::vector<std::string> panzer::GatherSolution_Input::dofNames_

private

Definition at line 126 of file Panzer_GatherSolution_Input.hpp.

indexerNames_

std::vector<std::string> panzer::GatherSolution_Input::indexerNames_

private

Definition at line 127 of file Panzer_GatherSolution_Input.hpp.

basis_

Teuchos::RCP<const PureBasis> panzer::GatherSolution_Input::basis_

private

Definition at line 128 of file Panzer_GatherSolution_Input.hpp.

useTimeDerivSolnVec_

bool panzer::GatherSolution_Input::useTimeDerivSolnVec_

private

Definition at line 129 of file Panzer_GatherSolution_Input.hpp.

globalDataKey_

std::string panzer::GatherSolution_Input::globalDataKey_

private

Definition at line 130 of file Panzer_GatherSolution_Input.hpp.

tangentNames_

std::vector<std::vector<std::string> > panzer::GatherSolution_Input::tangentNames_

private

Definition at line 133 of file Panzer_GatherSolution_Input.hpp.

sensName_

std::string panzer::GatherSolution_Input::sensName_

private

Definition at line 136 of file Panzer_GatherSolution_Input.hpp.

gatherSeedIndex_

int panzer::GatherSolution_Input::gatherSeedIndex_

private

Definition at line 137 of file Panzer_GatherSolution_Input.hpp.

firstSensAvail_

bool panzer::GatherSolution_Input::firstSensAvail_

private

Definition at line 138 of file Panzer_GatherSolution_Input.hpp.

secondSensAvail_

bool panzer::GatherSolution_Input::secondSensAvail_

private

Definition at line 141 of file Panzer_GatherSolution_Input.hpp.

secondSensDataKeyPrefix_

std::string panzer::GatherSolution_Input::secondSensDataKeyPrefix_

private

Definition at line 142 of file Panzer_GatherSolution_Input.hpp.

---

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

• Panzer_GatherSolution_Input.hpp
• Panzer_GatherSolution_Input.cpp