GatherSolution_BlockedEpetra (Tangent Specialization). More...

#include <Panzer_GatherSolution_BlockedEpetra_decl.hpp>

Inheritance diagram for panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >:

Public Types
typedef panzer::Traits::Tangent::ScalarT	ScalarT
	The scalar type.

Public Types inherited from panzer::DomainEvaluator
enum	DomainType : int { OWNED =0 , GHOST =1 , REAL =2 , VIRTUAL =3 , EXTERNAL =4 , ALL =5 }
	Domain types supported by worksets. More...

Public Member Functions
	GatherSolution_BlockedEpetra (const std::vector< Teuchos::RCP< const GlobalIndexer > > &indexers)
	Constructor.

	GatherSolution_BlockedEpetra (const std::vector< Teuchos::RCP< const GlobalIndexer > > &indexers, const Teuchos::ParameterList &p)
	Initializing Constructor.

void	postRegistrationSetup (typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &fm)
	Post-Registration Setup.

void	preEvaluate (typename TRAITS::PreEvalData d)
	Pre-Evaluate: Sets the solution vector.

void	evaluateFields (typename TRAITS::EvalData d)
	Evaluate Fields: Gather operation.

virtual Teuchos::RCP< CloneableEvaluator >	clone (const Teuchos::ParameterList &pl) const
	Create a copy.

	GatherSolution_BlockedEpetra (const Teuchos::ParameterList &p)
	Constructor.

virtual Teuchos::RCP< CloneableEvaluator >	clone (const Teuchos::ParameterList &pl) const
	Create a copy.

void	postRegistrationSetup (typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &fm)
	Post-Registration Setup.

void	evaluateFields (typename TRAITS::EvalData d)
	Evaluate Fields.

Public Member Functions inherited from panzer::EvaluatorWithBaseImpl< TRAITS >
void	setDetailsIndex (const int di)
	An evaluator builder sets the details index.

Public Member Functions inherited from panzer::DomainEvaluator
	DomainEvaluator (DomainType domain=ALL)
	Constructor.

virtual	~DomainEvaluator ()=default
	Default destructor.

void	setDomain (const DomainType domain)
	Set the domain for the evaluator.

DomainType	getDomain ()
	Get the domain for the evaluator.

virtual int	cellStartIndex (const panzer::Workset &workset) const
	Returns the starting cell for the specified domain for a given workset.

virtual int	cellEndIndex (const panzer::Workset &workset) const
	Returns the non-inclusive end cell for the specified domain for a given workset.

Public Member Functions inherited from panzer::CloneableEvaluator
	CloneableEvaluator ()

virtual	~CloneableEvaluator ()

Private Types
typedef panzer::Traits::Tangent	EvalT
	The evaluation type.

typedef panzer::Traits::Tangent::ScalarT	ScalarT
	The scalar type.

Private Member Functions
	GatherSolution_BlockedEpetra ()
	Default Constructor (disabled)

Private Attributes
std::vector< Teuchos::RCP< const GlobalIndexer > >	indexers_
	These map the local (field, element, basis) triplet to a global ID for scattering.

std::vector< int >	indexerIds_
	The block index into `indexers_`.

std::vector< int >	subFieldIds_
	Sub-field IDs, which need to be mapped.

std::vector< PHX::MDField< ScalarT, Cell, NODE > >	gatherFields_
	The fields to be gathered.

std::vector< std::string >	indexerNames_
	A list of the names of the fields to be gathered.

bool	useTimeDerivativeSolutionVector_
	A flag indicating whether we should be working with or $\dot{x}$ .

std::string	globalDataKey_
	The key identifying the `GlobalEvaluationData`.

Teuchos::RCP< Thyra::ProductVectorBase< double > >	x_
	The solution vector.

Teuchos::RCP< panzer::BlockedVector_ReadOnly_GlobalEvaluationData >	xBvRoGed_
	The `GlobalEvaluationData` containing both the owned and ghosted solution vectors.

bool	hasTangentFields_
	A flag indicating whether or not we have tangent fields.

std::vector< std::vector< PHX::MDField< const ScalarT, Cell, NODE > > >	tangentFields_
	Fields for storing the tangent components $\left(\frac{dx}{dp}\right)$ of the solution vector .

Additional Inherited Members
Protected Attributes inherited from panzer::EvaluatorWithBaseImpl< TRAITS >
WorksetDetailsAccessor	wda

Detailed Description

template<typename TRAITS, typename LO, typename GO>
class panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >

GatherSolution_BlockedEpetra (Tangent Specialization).

Gathers solution values from the Newton solution vector into the nodal fields of the field manager.

Currently makes an assumption that the stride is constant for degrees of freedom (DOFs) and that the nmber of DOFs is equal to the size of the solution names vector.

Definition at line 390 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Member Typedef Documentation

◆ EvalT

template<typename TRAITS, typename LO, typename GO>

typedef panzer::Traits::Tangent panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::EvalT

private

The evaluation type.

Definition at line 500 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ ScalarT [1/2]

template<typename TRAITS, typename LO, typename GO>

typedef panzer::Traits::Tangent::ScalarT panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::ScalarT

private

The scalar type.

Definition at line 505 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ ScalarT [2/2]

typedef panzer::Traits::Tangent::ScalarT panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::ScalarT

The scalar type.

Definition at line 105 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Constructor & Destructor Documentation

◆ GatherSolution_BlockedEpetra() [1/4]

template<typename TRAITS, typename LO, typename GO>

panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::GatherSolution_BlockedEpetra ( const std::vector< Teuchos::RCP< const GlobalIndexer > > & indexers )

inline

Constructor.

Simply saves the input indexers as this object's indexers_.

Parameters

[in] indexers The vector of GlobalIndexers that handle the global unknown numbering.

Definition at line 406 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ GatherSolution_BlockedEpetra() [2/4]

template<typename TRAITS, typename LO, typename GO>

panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::GatherSolution_BlockedEpetra	(	const std::vector< Teuchos::RCP< const GlobalIndexer > > &	indexers,
		const Teuchos::ParameterList &	p )

Initializing Constructor.

Saves the input indexers as this object's indexers_, allocates fields, sets up dependent tangent fields (if requested), and determines the first active name.

Parameters

[in]	indexers	The `vector` of `GlobalIndexer`s that handle the global unknown numbering.
[in]	p	A `ParameterList` used as input for `GatherSolution_Input`.

Definition at line 313 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

◆ GatherSolution_BlockedEpetra() [3/4]

template<typename TRAITS, typename LO, typename GO>

panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::GatherSolution_BlockedEpetra ( )

private

Default Constructor (disabled)

◆ GatherSolution_BlockedEpetra() [4/4]

panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::GatherSolution_BlockedEpetra ( const Teuchos::ParameterList & p )

inline

Constructor.

For this unspecialized class, this constructor is empty; that is, it doesn't do anything with the input ParameterList.

Parameters

[in] p A ParameterList that isn't used.

Definition at line 115 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Member Function Documentation

◆ postRegistrationSetup() [1/2]

template<typename TRAITS, typename LO, typename GO>

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::postRegistrationSetup	(	typename TRAITS::SetupData	d,
		PHX::FieldManager< TRAITS > &	fm )

Post-Registration Setup.

Loops over the gatherFields_ and sets the indexerIds_ and subFieldIds_.

Parameters

[in]	d	Unused.
[in]	fm	Unused.

Definition at line 385 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

◆ preEvaluate()

template<typename TRAITS, typename LO, typename GO>

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::preEvaluate ( typename TRAITS::PreEvalData d )

Pre-Evaluate: Sets the solution vector.

If using a BlockedVector_ReadOnly_GlobalEvaluationData, this saves it for use later in evaluateFields(). If using the older BlockedEpetraLinearObjContainer, this sets the solution vector.

Parameters

[in] d The PreEvalData containing the GlobalEvaluationDataContainer.

Definition at line 414 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

◆ evaluateFields() [1/2]

template<typename TRAITS, typename LO, typename GO>

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::evaluateFields ( typename TRAITS::EvalData d )

Evaluate Fields: Gather operation.

Loops over the fields to be gathered, the cells in the workset, and the basis functions, and fills in the fields. Also sets derivative information if tangent fields are enabled.

Parameters

[in] d The Workset on which we're going to do all the work.

Definition at line 468 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

◆ clone() [1/2]

template<typename TRAITS, typename LO, typename GO>

virtual Teuchos::RCP< CloneableEvaluator > panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::clone ( const Teuchos::ParameterList & pl ) const

inlinevirtual

Create a copy.

Creates a GatherSolution_BlockedEpetra using the Initializing Constructor and the current object's indexers_.

Parameters

[in] pl A ParameterList used as input for GatherSolution_Input.

Returns: A GatherSolution_BlockedEpetra constructed with this object's indexers_ and the input ParameterList.

Implements panzer::CloneableEvaluator.

Definition at line 485 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ clone() [2/2]

virtual Teuchos::RCP< CloneableEvaluator > panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::clone ( const Teuchos::ParameterList & pl ) const

inlinevirtual

Create a copy.

For this unspecialized class, this actually just calls the Default Constructor and doesn't copy anything.

Parameters

[in] pl A ParameterList, which is passed to the Default Constructor.

Returns: A GatherSolution_BlockedEpetra created by the Default Constructor.

Implements panzer::CloneableEvaluator.

Definition at line 133 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ postRegistrationSetup() [2/2]

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::postRegistrationSetup	(	typename TRAITS::SetupData	d,
		PHX::FieldManager< TRAITS > &	fm )

inline

Post-Registration Setup.

For this unspecialized class, this routine does nothing.

Parameters

[in]	d	Unused.
[in]	fm	Unused.

Definition at line 149 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ evaluateFields() [2/2]

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::evaluateFields ( typename TRAITS::EvalData d )

inline

Evaluate Fields.

For this unspecialized class, this routine does nothing, other than tell you that you can't use it.

Parameters

[in] d Unused.

Definition at line 164 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Member Data Documentation

◆ indexers_

template<typename TRAITS, typename LO, typename GO>

std::vector<Teuchos::RCP<const GlobalIndexer> > panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::indexers_

private

These map the local (field, element, basis) triplet to a global ID for scattering.

Definition at line 511 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ indexerIds_

template<typename TRAITS, typename LO, typename GO>

std::vector<int> panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::indexerIds_

private

The block index into indexers_.

Definition at line 516 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ subFieldIds_

template<typename TRAITS, typename LO, typename GO>

std::vector<int> panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::subFieldIds_

private

Sub-field IDs, which need to be mapped.

Definition at line 521 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ gatherFields_

template<typename TRAITS, typename LO, typename GO>

std::vector<PHX::MDField<ScalarT, Cell, NODE> > panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::gatherFields_

private

The fields to be gathered.

Definition at line 526 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ indexerNames_

template<typename TRAITS, typename LO, typename GO>

std::vector<std::string> panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::indexerNames_

private

A list of the names of the fields to be gathered.

Definition at line 531 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ useTimeDerivativeSolutionVector_

template<typename TRAITS, typename LO, typename GO>

bool panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::useTimeDerivativeSolutionVector_

private

A flag indicating whether we should be working with $ x $ or $\dot{x}$ .

Definition at line 537 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ globalDataKey_

template<typename TRAITS, typename LO, typename GO>

std::string panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::globalDataKey_

private

The key identifying the GlobalEvaluationData.

Definition at line 542 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ x_

template<typename TRAITS, typename LO, typename GO>

Teuchos::RCP<Thyra::ProductVectorBase<double> > panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::x_

private

The solution vector.

Definition at line 547 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ xBvRoGed_

template<typename TRAITS, typename LO, typename GO>

Teuchos::RCP<panzer::BlockedVector_ReadOnly_GlobalEvaluationData> panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::xBvRoGed_

private

The GlobalEvaluationData containing both the owned and ghosted solution vectors.

Definition at line 554 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ hasTangentFields_

template<typename TRAITS, typename LO, typename GO>

bool panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::hasTangentFields_

private

A flag indicating whether or not we have tangent fields.

Definition at line 559 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

◆ tangentFields_

template<typename TRAITS, typename LO, typename GO>

std::vector<std::vector<PHX::MDField<const ScalarT, Cell, NODE> > > panzer::GatherSolution_BlockedEpetra< panzer::Traits::Tangent, TRAITS, LO, GO >::tangentFields_

private

Fields for storing the tangent components $\left(\frac{dx}{dp}\right)$ of the solution vector $(x)$ .

These are not actually used by the residual specialization of this evaluator, even if they are supplied, but it is useful to declare them as dependencies anyway when saving the tangent components to the output file.

Definition at line 572 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ EvalT

◆ ScalarT [1/2]

◆ ScalarT [2/2]

Constructor & Destructor Documentation

◆ GatherSolution_BlockedEpetra() [1/4]

◆ GatherSolution_BlockedEpetra() [2/4]

◆ GatherSolution_BlockedEpetra() [3/4]

◆ GatherSolution_BlockedEpetra() [4/4]

Member Function Documentation

◆ postRegistrationSetup() [1/2]

◆ preEvaluate()

◆ evaluateFields() [1/2]

◆ clone() [1/2]

◆ clone() [2/2]

◆ postRegistrationSetup() [2/2]

◆ evaluateFields() [2/2]

Member Data Documentation

◆ indexers_

◆ indexerIds_

◆ subFieldIds_

◆ gatherFields_

◆ indexerNames_

◆ useTimeDerivativeSolutionVector_

◆ globalDataKey_

◆ x_

◆ xBvRoGed_

◆ hasTangentFields_

◆ tangentFields_