Unified set of tools for building objects for lumped and consistent L2 projects between bases. More...

#include <Panzer_L2Projection.hpp>

Public Member Functions
	L2Projection ()
	Constructor.
void	setup (const panzer::BasisDescriptor &targetBasis, const panzer::IntegrationDescriptor &integrationDescriptor, const Teuchos::RCP< const Teuchos::MpiComm< int > > &comm, const Teuchos::RCP< const panzer::ConnManager > &connManager, const std::vector< std::string > &elementBlockNames, const Teuchos::RCP< panzer::WorksetContainer > worksetContainer=Teuchos::null)
	Setup base objects for L2 Projections - requires target scalar basis and creates worksets if not supplied by user.
void	useBasisValues (const std::map< std::string, Teuchos::RCP< panzer::BasisValues2< double > > > &map_eblock_to_bv)
	Override using the panzer::WorksetContainer and instead use the registered BasisValues object.
Teuchos::RCP< panzer::GlobalIndexer >	getTargetGlobalIndexer () const
	Returns the target global indexer. Will be null if setup() has not been called.
Teuchos::RCP< Tpetra::CrsMatrix< double, panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > >	buildMassMatrix (bool use_lumping=false, const std::unordered_map< std::string, double > *elementBlockMultipliers=nullptr)
	Allocates, fills and returns a mass matrix for L2 projection onto a target basis.
Teuchos::RCP< Tpetra::MultiVector< double, panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > >	buildInverseLumpedMassMatrix ()
	Allocates, fills and returns a Tpetra::MultiVector containing the inverse lumped mass matrix values as computed via Hinton 1976.
Teuchos::RCP< Tpetra::CrsMatrix< double, panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > >	buildRHSMatrix (const panzer::GlobalIndexer &sourceDOFManager, const Teuchos::RCP< const Tpetra::Map< panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > > &ownedSourceMap, const std::string &sourceFieldName, const panzer::BasisDescriptor &sourceBasisDescriptor, const int vectorOrGradientDirectionIndex=-1)
	Allocates, fills and returns a rectangular matrix for L2 projection of a scalar field, one dimension of gradient (for hgrad basis), or one dimension of a vector field onto the target scalar basis. If you wish to project all values of a vector field or all the gradients of a scalar field, then you will need three separate RHS matrices to form the RHS for each independently. The vectors must be independent Tpetra vectors to solve multiple right hand sides with the linear solver.

Private Attributes
panzer::BasisDescriptor	targetBasisDescriptor_
panzer::IntegrationDescriptor	integrationDescriptor_
Teuchos::RCP< const Teuchos::MpiComm< int > >	comm_
Teuchos::RCP< const panzer::ConnManager >	connManager_
std::vector< std::string >	elementBlockNames_
Teuchos::RCP< panzer::WorksetContainer >	worksetContainer_
bool	setupCalled_
Teuchos::RCP< panzer::DOFManager >	targetGlobalIndexer_
bool	useUserSuppliedBasisValues_
std::map< std::string, Teuchos::RCP< panzer::BasisValues2< double > > >	basisValues_

Detailed Description

Unified set of tools for building objects for lumped and consistent L2 projects between bases.

Definition at line 44 of file Panzer_L2Projection.hpp.

Constructor & Destructor Documentation

◆ L2Projection()

panzer::L2Projection::L2Projection ( )

inline

Constructor.

Definition at line 60 of file Panzer_L2Projection.hpp.

Member Function Documentation

◆ setup()

void panzer::L2Projection::setup	(	const panzer::BasisDescriptor &	targetBasis,
		const panzer::IntegrationDescriptor &	integrationDescriptor,
		const Teuchos::RCP< const Teuchos::MpiComm< int > > &	comm,
		const Teuchos::RCP< const panzer::ConnManager > &	connManager,
		const std::vector< std::string > &	elementBlockNames,
		const Teuchos::RCP< panzer::WorksetContainer >	worksetContainer = Teuchos::null )

Setup base objects for L2 Projections - requires target scalar basis and creates worksets if not supplied by user.

Parameters

[in]	basis	(required) Basis that field values will be projected to.
[in]	integrationDescriptor	(required) Integration order used for the projection.
[in]	comm	(required) Teuchos MPI communicator used all processes involved in the project.
[in]	connManger	(required) Connection manager to describe the mesh.
[in]	elementBlockNames	(required) Names of element blocks in mesh that are involved in the projection.
[in]	worksetContainer	(optional) If the user has already allocated worksets for the corresponding mesh/element blocks, we can used those instead of reallocating for projection.

Definition at line 33 of file Panzer_L2Projection.cpp.

◆ useBasisValues()

void panzer::L2Projection::useBasisValues ( const std::map< std::string, Teuchos::RCP< panzer::BasisValues2< double > > > & map_eblock_to_bv )

Override using the panzer::WorksetContainer and instead use the registered BasisValues object.

Parameters

[in] bv BasisValues object setup in lazy evalaution mode with registered orientations if required.

The intention of this function is to minimize memory use and redundant evaluations by avoiding workset construction and enforcing lazy evaluation in basis values.

Definition at line 77 of file Panzer_L2Projection.cpp.

◆ getTargetGlobalIndexer()

Teuchos::RCP< panzer::GlobalIndexer > panzer::L2Projection::getTargetGlobalIndexer ( ) const

Returns the target global indexer. Will be null if setup() has not been called.

Definition at line 90 of file Panzer_L2Projection.cpp.

◆ buildMassMatrix()

Teuchos::RCP< Tpetra::CrsMatrix< double, panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > > panzer::L2Projection::buildMassMatrix	(	bool	use_lumping = false,
		const std::unordered_map< std::string, double > *	elementBlockMultipliers = nullptr )

Allocates, fills and returns a mass matrix for L2 projection onto a target basis.

Parameters

use_lumping	(optional) If set to true, the returned mass matrix is a lumped diagonal mass matrix following Hinton, et al. 1976.
elementBlockMultipliers	(optional) If non-null, a multiplier will be used for each element block. The elements should be ordered corresponding to commManger block ordering.

Returns: Filled mass matrix in a Tpetra::CrsMatrix

Definition at line 94 of file Panzer_L2Projection.cpp.

◆ buildInverseLumpedMassMatrix()

Teuchos::RCP< Tpetra::MultiVector< double, panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > > panzer::L2Projection::buildInverseLumpedMassMatrix ( )

Allocates, fills and returns a Tpetra::MultiVector containing the inverse lumped mass matrix values as computed via Hinton 1976.

References:

[1] E. Hinton, T. Rock and O. C. Zienkiewicz, "A Note on Mass Lumping and Related Processes in the Finite Element Method," Earthquake Engineering and Structural Dynamics, 4 (1976), 245-249.

[2] T. J. R. Hughes, "The Finite Element Method: Linear Static and Dynamic Finite Element Analysis," (1987), Section 7.3.2.

NOTE: This is currently sligtly inefficient in that it temporarily allocates the consistent mass matrix. This saves significant code duplication at the temporary runtime cost of allocating the mass matrix. The temporary matrix is deallocated on exit from this function so it should not be an issue.

Returns: Filled inverse lumped mass matrix in a Tpetra::MultiVector (diagonal entries mass matrix)

Definition at line 367 of file Panzer_L2Projection.cpp.

◆ buildRHSMatrix()

Teuchos::RCP< Tpetra::CrsMatrix< double, panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > > panzer::L2Projection::buildRHSMatrix	(	const panzer::GlobalIndexer &	sourceDOFManager,
		const Teuchos::RCP< const Tpetra::Map< panzer::LocalOrdinal, panzer::GlobalOrdinal, panzer::TpetraNodeType > > &	ownedSourceMap,
		const std::string &	sourceFieldName,
		const panzer::BasisDescriptor &	sourceBasisDescriptor,
		const int	vectorOrGradientDirectionIndex = -1 )

Allocates, fills and returns a rectangular matrix for L2 projection of a scalar field, one dimension of gradient (for hgrad basis), or one dimension of a vector field onto the target scalar basis. If you wish to project all values of a vector field or all the gradients of a scalar field, then you will need three separate RHS matrices to form the RHS for each independently. The vectors must be independent Tpetra vectors to solve multiple right hand sides with the linear solver.

Parameters

[in]	(required)	sourceDOFManager The source dof manger object
[in]	(required)	ownedSourceMap The Tpetra Map for the owned source vector
[in]	(required)	sourceFieldName The string name of the source field to project
[in]	(required)	sourceBasisDescriptor The type of the basis for the source field
[in]	(optional)	vectorOrGradientDirectionIndex For vector fields, this is the vector index to project (x,y, or z component). For scalar fields, the default value of -1 results in a projection of the scalar field value. If set to 0 or greater, it is assumed that the gradient of the HGrad field is projected and that this value is the dimension index for the particular gradient (x, y, or z component).

Returns: Alocated and filled Tpetra::CrsMatrix

Definition at line 387 of file Panzer_L2Projection.cpp.

Member Data Documentation

◆ targetBasisDescriptor_

panzer::BasisDescriptor panzer::L2Projection::targetBasisDescriptor_

private

Definition at line 46 of file Panzer_L2Projection.hpp.

◆ integrationDescriptor_

panzer::IntegrationDescriptor panzer::L2Projection::integrationDescriptor_

private

Definition at line 47 of file Panzer_L2Projection.hpp.

◆ comm_

Teuchos::RCP<const Teuchos::MpiComm<int> > panzer::L2Projection::comm_

private

Definition at line 48 of file Panzer_L2Projection.hpp.

◆ connManager_

Teuchos::RCP<const panzer::ConnManager> panzer::L2Projection::connManager_

private

Definition at line 49 of file Panzer_L2Projection.hpp.

◆ elementBlockNames_

std::vector<std::string> panzer::L2Projection::elementBlockNames_

private

Definition at line 50 of file Panzer_L2Projection.hpp.

◆ worksetContainer_

Teuchos::RCP<panzer::WorksetContainer> panzer::L2Projection::worksetContainer_

mutableprivate

Definition at line 51 of file Panzer_L2Projection.hpp.

◆ setupCalled_

bool panzer::L2Projection::setupCalled_

private

Definition at line 52 of file Panzer_L2Projection.hpp.

◆ targetGlobalIndexer_

Teuchos::RCP<panzer::DOFManager> panzer::L2Projection::targetGlobalIndexer_

private

Definition at line 53 of file Panzer_L2Projection.hpp.

◆ useUserSuppliedBasisValues_

bool panzer::L2Projection::useUserSuppliedBasisValues_

private

Definition at line 54 of file Panzer_L2Projection.hpp.

◆ basisValues_

std::map<std::string,Teuchos::RCP<panzer::BasisValues2<double> > > panzer::L2Projection::basisValues_

private

Definition at line 55 of file Panzer_L2Projection.hpp.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ L2Projection()

Member Function Documentation

◆ setup()

◆ useBasisValues()

◆ getTargetGlobalIndexer()

◆ buildMassMatrix()

◆ buildInverseLumpedMassMatrix()

◆ buildRHSMatrix()

Member Data Documentation

◆ targetBasisDescriptor_

◆ integrationDescriptor_

◆ comm_

◆ connManager_

◆ elementBlockNames_

◆ worksetContainer_

◆ setupCalled_

◆ targetGlobalIndexer_

◆ useUserSuppliedBasisValues_

◆ basisValues_