panzer::GatherSolution_Input Class Reference

#include <Panzer_GatherSolution_Input.hpp>

Inheritance diagram for panzer::GatherSolution_Input:

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 Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
RCP< ParameterList >	getNonconstParameterList ()
RCP< ParameterList >	unsetParameterList ()
RCP< const ParameterList >	getParameterList () const
void	setMyParamList (const RCP< ParameterList > &paramList)
RCP< ParameterList >	getMyNonconstParamList ()
RCP< const ParameterList >	getMyParamList () const

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 30 of file Panzer_GatherSolution_Input.hpp.

Constructor & Destructor Documentation

panzer::GatherSolution_Input::GatherSolution_Input

(

)

Definition at line 16 of file Panzer_GatherSolution_Input.cpp.

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

private

Member Function Documentation

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 23 of file Panzer_GatherSolution_Input.cpp.

void panzer::GatherSolution_Input::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > &  pl )

virtual

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 30 of file Panzer_GatherSolution_Input.cpp.

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

virtual

Get valid parameters.

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 68 of file Panzer_GatherSolution_Input.cpp.

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

inline

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

Definition at line 50 of file Panzer_GatherSolution_Input.hpp.

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 55 of file Panzer_GatherSolution_Input.hpp.

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

inline

Basis definiting layout of dof names (all types)

Definition at line 58 of file Panzer_GatherSolution_Input.hpp.

bool panzer::GatherSolution_Input::useTimeDerivativeSolutionVector ( ) const

inline

Gather a time derivative vector? (all types)

Definition at line 61 of file Panzer_GatherSolution_Input.hpp.

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 64 of file Panzer_GatherSolution_Input.hpp.

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 69 of file Panzer_GatherSolution_Input.hpp.

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

inline

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

Definition at line 74 of file Panzer_GatherSolution_Input.hpp.

int panzer::GatherSolution_Input::getGatherSeedIndex ( ) const

inline

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

Definition at line 77 of file Panzer_GatherSolution_Input.hpp.

bool panzer::GatherSolution_Input::firstSensitivitiesAvailable ( )

inline

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

Definition at line 80 of file Panzer_GatherSolution_Input.hpp.

bool panzer::GatherSolution_Input::secondSensitivitiesAvailable ( )

inline

Are second derivative sensitivies enabled or disabled (Hessian only)

Definition at line 85 of file Panzer_GatherSolution_Input.hpp.

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

inline

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

Definition at line 88 of file Panzer_GatherSolution_Input.hpp.

Member Data Documentation

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

private

Definition at line 94 of file Panzer_GatherSolution_Input.hpp.

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

private

Definition at line 95 of file Panzer_GatherSolution_Input.hpp.

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

private

Definition at line 96 of file Panzer_GatherSolution_Input.hpp.

bool panzer::GatherSolution_Input::useTimeDerivSolnVec_

private

Definition at line 97 of file Panzer_GatherSolution_Input.hpp.

std::string panzer::GatherSolution_Input::globalDataKey_

private

Definition at line 98 of file Panzer_GatherSolution_Input.hpp.

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

private

Definition at line 101 of file Panzer_GatherSolution_Input.hpp.

std::string panzer::GatherSolution_Input::sensName_

private

Definition at line 104 of file Panzer_GatherSolution_Input.hpp.

int panzer::GatherSolution_Input::gatherSeedIndex_

private

Definition at line 105 of file Panzer_GatherSolution_Input.hpp.

bool panzer::GatherSolution_Input::firstSensAvail_

private

Definition at line 106 of file Panzer_GatherSolution_Input.hpp.

bool panzer::GatherSolution_Input::secondSensAvail_

private

Definition at line 109 of file Panzer_GatherSolution_Input.hpp.

std::string panzer::GatherSolution_Input::secondSensDataKeyPrefix_

private

Definition at line 110 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