MFEM  v4.6.0
Finite element discretization library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::GridTransfer Class Referenceabstract

Base class for transfer algorithms that construct transfer Operators between two finite element (FE) spaces. More...

#include <transfer.hpp>

Inheritance diagram for mfem::GridTransfer:
[legend]
Collaboration diagram for mfem::GridTransfer:
[legend]

Public Member Functions

 GridTransfer (FiniteElementSpace &dom_fes_, FiniteElementSpace &ran_fes_)
 
virtual ~GridTransfer ()
 Virtual destructor. More...
 
void SetOperatorType (Operator::Type type)
 Set the desired Operator::Type for the construction of all operators defined by the underlying transfer algorithm. More...
 
virtual const OperatorForwardOperator ()=0
 Return an Operator that transfers GridFunctions from the domain FE space to GridFunctions in the range FE space. More...
 
virtual const OperatorBackwardOperator ()=0
 Return an Operator that transfers GridFunctions from the range FE space back to GridFunctions in the domain FE space. More...
 
virtual const OperatorTrueForwardOperator ()
 Return an Operator that transfers true-dof Vectors from the domain FE space to true-dof Vectors in the range FE space. More...
 
virtual const OperatorTrueBackwardOperator ()
 Return an Operator that transfers true-dof Vectors from the range FE space back to true-dof Vectors in the domain FE space. More...
 
virtual bool SupportsBackwardsOperator () const
 

Protected Member Functions

bool Parallel () const
 
const OperatorMakeTrueOperator (FiniteElementSpace &fes_in, FiniteElementSpace &fes_out, const Operator &oper, OperatorHandle &t_oper)
 

Protected Attributes

FiniteElementSpacedom_fes
 Domain FE space. More...
 
FiniteElementSpaceran_fes
 Range FE space. More...
 
Operator::Type oper_type
 Desired Operator::Type for the construction of all operators defined by the underlying transfer algorithm. It can be ignored by derived classes. More...
 
OperatorHandle fw_t_oper
 Forward true-dof operator. More...
 
OperatorHandle bw_t_oper
 Backward true-dof operator. More...
 
bool parallel
 

Detailed Description

Base class for transfer algorithms that construct transfer Operators between two finite element (FE) spaces.

Generally, the two FE spaces (domain and range) can be defined on different meshes.

Definition at line 29 of file transfer.hpp.

Constructor & Destructor Documentation

◆ GridTransfer()

mfem::GridTransfer::GridTransfer ( FiniteElementSpace dom_fes_,
FiniteElementSpace ran_fes_ 
)

Construct a transfer algorithm between the domain, dom_fes_, and range, ran_fes_, FE spaces.

Definition at line 19 of file transfer.cpp.

◆ ~GridTransfer()

virtual mfem::GridTransfer::~GridTransfer ( )
inlinevirtual

Virtual destructor.

Definition at line 66 of file transfer.hpp.

Member Function Documentation

◆ BackwardOperator()

virtual const Operator& mfem::GridTransfer::BackwardOperator ( )
pure virtual

Return an Operator that transfers GridFunctions from the range FE space back to GridFunctions in the domain FE space.

Implemented in mfem::L2ProjectionGridTransfer, and mfem::InterpolationGridTransfer.

◆ ForwardOperator()

virtual const Operator& mfem::GridTransfer::ForwardOperator ( )
pure virtual

Return an Operator that transfers GridFunctions from the domain FE space to GridFunctions in the range FE space.

Implemented in mfem::L2ProjectionGridTransfer, and mfem::InterpolationGridTransfer.

◆ MakeTrueOperator()

const Operator & mfem::GridTransfer::MakeTrueOperator ( FiniteElementSpace fes_in,
FiniteElementSpace fes_out,
const Operator oper,
OperatorHandle t_oper 
)
protected

Definition at line 34 of file transfer.cpp.

◆ Parallel()

bool mfem::GridTransfer::Parallel ( ) const
inlineprotected

Definition at line 46 of file transfer.hpp.

◆ SetOperatorType()

void mfem::GridTransfer::SetOperatorType ( Operator::Type  type)
inline

Set the desired Operator::Type for the construction of all operators defined by the underlying transfer algorithm.

The default value is Operator::ANY_TYPE which typically corresponds to a matrix-free operator representation. Note that derived classes are not required to support this setting and can ignore it.

Definition at line 73 of file transfer.hpp.

◆ SupportsBackwardsOperator()

virtual bool mfem::GridTransfer::SupportsBackwardsOperator ( ) const
inlinevirtual

Reimplemented in mfem::L2ProjectionGridTransfer.

Definition at line 102 of file transfer.hpp.

◆ TrueBackwardOperator()

virtual const Operator& mfem::GridTransfer::TrueBackwardOperator ( )
inlinevirtual

Return an Operator that transfers true-dof Vectors from the range FE space back to true-dof Vectors in the domain FE space.

This method is implemented in the base class, based on BackwardOperator(), however, derived classes can overload the construction, if necessary.

Definition at line 97 of file transfer.hpp.

◆ TrueForwardOperator()

virtual const Operator& mfem::GridTransfer::TrueForwardOperator ( )
inlinevirtual

Return an Operator that transfers true-dof Vectors from the domain FE space to true-dof Vectors in the range FE space.

This method is implemented in the base class, based on ForwardOperator(), however, derived classes can overload the construction, if necessary.

Definition at line 87 of file transfer.hpp.

Member Data Documentation

◆ bw_t_oper

OperatorHandle mfem::GridTransfer::bw_t_oper
protected

Backward true-dof operator.

Definition at line 41 of file transfer.hpp.

◆ dom_fes

FiniteElementSpace& mfem::GridTransfer::dom_fes
protected

Domain FE space.

Definition at line 32 of file transfer.hpp.

◆ fw_t_oper

OperatorHandle mfem::GridTransfer::fw_t_oper
protected

Forward true-dof operator.

Definition at line 40 of file transfer.hpp.

◆ oper_type

Operator::Type mfem::GridTransfer::oper_type
protected

Desired Operator::Type for the construction of all operators defined by the underlying transfer algorithm. It can be ignored by derived classes.

Definition at line 38 of file transfer.hpp.

◆ parallel

bool mfem::GridTransfer::parallel
protected

Definition at line 44 of file transfer.hpp.

◆ ran_fes

FiniteElementSpace& mfem::GridTransfer::ran_fes
protected

Range FE space.

Definition at line 33 of file transfer.hpp.


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