GatherSolution_BlockedEpetra (Jacobian Specialization). More...

#include <Panzer_GatherSolution_BlockedEpetra_decl.hpp>

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

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

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

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

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

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

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

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

Public Member Functions inherited from PHX::EvaluatorWithBaseImpl< TRAITS >
virtual void	evaluateFields (typename Traits::EvalData d) override=0

Public Member Functions inherited from PHX::Evaluator< Traits >
	Evaluator ()

virtual	~Evaluator ()

virtual void	postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &vm)=0

virtual const std::vector < Teuchos::RCP< FieldTag > > &	evaluatedFields () const =0

virtual const std::vector < Teuchos::RCP< FieldTag > > &	contributedFields () const =0

virtual const std::vector < Teuchos::RCP< FieldTag > > &	dependentFields () const =0

virtual const std::vector < Teuchos::RCP< FieldTag > > &	unsharedFields () const =0

virtual void	preEvaluate (typename Traits::PreEvalData d)=0

virtual void	postEvaluate (typename Traits::PostEvalData d)=0

virtual const std::string &	getName () const =0

virtual void	bindField (const PHX::FieldTag &ft, const PHX::any &f)=0

virtual PHX::DeviceEvaluator < Traits > *	createDeviceEvaluator () const =0

virtual void	rebuildDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const =0

virtual void	deleteDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const =0

virtual void	printFieldValues (std::ostream &os) const =0

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

virtual	~DomainEvaluator ()=default
	Default destructor. More...

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

DomainType	getDomain ()
	Get the domain for the evaluator. More...

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

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

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

virtual	~CloneableEvaluator ()

Private Types
typedef panzer::Traits::Jacobian	EvalT
	The evaluation type. More...

typedef panzer::Traits::Jacobian::ScalarT	ScalarT
	The scalar type. More...

Private Member Functions
	GatherSolution_BlockedEpetra ()
	Default Constructor (disabled) More...

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

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

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

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

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

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

bool	disableSensitivities_
	Flag to disable sensitivities absolutely. More...

std::string	sensitivitiesName_
	Sets which gather operations have sensitivities. More...

bool	applySensitivities_
	Used by `evaluateFields()` to turn on/off a certain set of sensitivities. More...

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

int	gatherSeedIndex_
	Which gather seed in the workset to use. More...

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

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

Additional Inherited Members
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...

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

Detailed Description

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

GatherSolution_BlockedEpetra (Jacobian 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 592 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Member Typedef Documentation

template<typename TRAITS , typename LO , typename GO >

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

private

The evaluation type.

Definition at line 703 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

The scalar type.

Definition at line 708 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Constructor & Destructor Documentation

template<typename TRAITS , typename LO , typename GO >

panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, 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 608 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, 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 594 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

Default Constructor (disabled)

Member Function Documentation

template<typename TRAITS , typename LO , typename GO >

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, 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 648 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

template<typename TRAITS , typename LO , typename GO >

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, 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. Also determines whether or not to apply sensitivities.

Parameters

[in] d The PreEvalData containing the GlobalEvaluationDataContainer.

Definition at line 678 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

template<typename TRAITS , typename LO , typename GO >

void panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, 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. If sensitivities are to be applied, this also seeds the derivatives.

Parameters

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

Definition at line 740 of file Panzer_GatherSolution_BlockedEpetra_impl.hpp.

template<typename TRAITS , typename LO , typename GO >

virtual Teuchos::RCP<CloneableEvaluator> panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, 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 688 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

Member Data Documentation

template<typename TRAITS , typename LO , typename GO >

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

private

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

Definition at line 714 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

The block index into indexers_.

Definition at line 719 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

Sub-field IDs, which need to be mapped.

Definition at line 724 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

The fields to be gathered.

Definition at line 729 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

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

Definition at line 734 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

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

Definition at line 740 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

bool panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, TRAITS, LO, GO >::disableSensitivities_

private

Flag to disable sensitivities absolutely.

Definition at line 745 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

std::string panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, TRAITS, LO, GO >::sensitivitiesName_

private

Sets which gather operations have sensitivities.

Definition at line 750 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

bool panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, TRAITS, LO, GO >::applySensitivities_

private

Used by evaluateFields() to turn on/off a certain set of sensitivities.

Definition at line 756 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

The key identifying the GlobalEvaluationData.

Definition at line 761 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

int panzer::GatherSolution_BlockedEpetra< panzer::Traits::Jacobian, TRAITS, LO, GO >::gatherSeedIndex_

private

Which gather seed in the workset to use.

If it's less than zero, then use alpha or beta as appropriate.

Definition at line 768 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

The solution vector.

Definition at line 773 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

template<typename TRAITS , typename LO , typename GO >

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

private

The GlobalEvaluationData containing both the owned and ghosted solution vectors.

Definition at line 780 of file Panzer_GatherSolution_BlockedEpetra_decl.hpp.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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