MFEM v4.8.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::MassIntegrator Class Reference

#include <bilininteg.hpp>

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

Classes

struct  Kernels
 

Public Types

using ApplyKernelType
 
using DiagonalKernelType
 
- Public Types inherited from mfem::NonlinearFormIntegrator
enum  Mode { ELEMENTWISE = 0 , PATCHWISE = 1 , PATCHWISE_REDUCED = 2 }
 

Public Member Functions

 MFEM_REGISTER_KERNELS (ApplyPAKernels, ApplyKernelType,(int, int, int))
 
 MFEM_REGISTER_KERNELS (DiagonalPAKernels, DiagonalKernelType,(int, int, int))
 
 MassIntegrator (const IntegrationRule *ir=nullptr)
 
 MassIntegrator (Coefficient &q, const IntegrationRule *ir=NULL)
 Construct a mass integrator with coefficient q.
 
void AssembleElementMatrix (const FiniteElement &el, ElementTransformation &Trans, DenseMatrix &elmat) override
 
void AssembleElementMatrix2 (const FiniteElement &trial_fe, const FiniteElement &test_fe, ElementTransformation &Trans, DenseMatrix &elmat) override
 
void AssembleMF (const FiniteElementSpace &fes) override
 Method defining matrix-free assembly.
 
void AssemblePA (const FiniteElementSpace &fes) override
 Method defining partial assembly.
 
void AssemblePABoundary (const FiniteElementSpace &fes) override
 
void AssembleEA (const FiniteElementSpace &fes, Vector &emat, const bool add) override
 Method defining element assembly.
 
virtual void AssembleEABoundary (const FiniteElementSpace &fes, Vector &emat, const bool add) override
 
virtual void AssembleDiagonalPA (Vector &diag) override
 Assemble diagonal and add it to Vector diag.
 
void AssembleDiagonalMF (Vector &diag) override
 Assemble diagonal and add it to Vector diag.
 
void AddMultMF (const Vector &, Vector &) const override
 
void AddMultPA (const Vector &, Vector &) const override
 Method for partially assembled action.
 
void AddMultTransposePA (const Vector &, Vector &) const override
 Method for partially assembled transposed action.
 
bool SupportsCeed () const override
 Indicates whether this integrator can use a Ceed backend.
 
const CoefficientGetCoefficient () const
 
void AssemblePA (const FiniteElementSpace &trial_fes, const FiniteElementSpace &test_fes) override
 
- Public Member Functions inherited from mfem::BilinearFormIntegrator
virtual void AssembleNURBSPA (const FiniteElementSpace &fes)
 Method defining partial assembly on NURBS patches.
 
virtual void AssemblePAInteriorFaces (const FiniteElementSpace &fes)
 
virtual void AssemblePABoundaryFaces (const FiniteElementSpace &fes)
 
virtual void AssembleDiagonalPA_ADAt (const Vector &D, Vector &diag)
 Assemble diagonal of \(A D A^T\) ( \(A\) is this integrator) and add it to diag.
 
virtual void AddMultNURBSPA (const Vector &x, Vector &y) const
 Method for partially assembled action on NURBS patches.
 
virtual void AddMultTransposeMF (const Vector &x, Vector &y) const
 
virtual void AssembleEAInteriorFaces (const FiniteElementSpace &fes, Vector &ea_data_int, Vector &ea_data_ext, const bool add=true)
 
virtual void AssembleEAInteriorFaces (const FiniteElementSpace &trial_fes, const FiniteElementSpace &test_fes, Vector &emat, const bool add=true)
 Method defining element assembly for mixed trace integrators.
 
virtual void AssembleEABoundaryFaces (const FiniteElementSpace &fes, Vector &ea_data_bdr, const bool add=true)
 
virtual void AssemblePatchMatrix (const int patch, const FiniteElementSpace &fes, SparseMatrix *&smat)
 
virtual void AssembleFaceMatrix (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Trans, DenseMatrix &elmat)
 
virtual void AssembleFaceMatrix (const FiniteElement &trial_fe1, const FiniteElement &test_fe1, const FiniteElement &trial_fe2, const FiniteElement &test_fe2, FaceElementTransformations &Trans, DenseMatrix &elmat)
 
virtual void AssembleFaceMatrix (const FiniteElement &trial_face_fe, const FiniteElement &test_fe1, const FiniteElement &test_fe2, FaceElementTransformations &Trans, DenseMatrix &elmat)
 
virtual void AssembleTraceFaceMatrix (int elem, const FiniteElement &trial_face_fe, const FiniteElement &test_fe, FaceElementTransformations &Trans, DenseMatrix &elmat)
 
void AssembleElementVector (const FiniteElement &el, ElementTransformation &Tr, const Vector &elfun, Vector &elvect) override
 Perform the local action of the BilinearFormIntegrator. Note that the default implementation in the base class is general but not efficient.
 
void AssembleFaceVector (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Tr, const Vector &elfun, Vector &elvect) override
 Perform the local action of the BilinearFormIntegrator resulting from a face integral term. Note that the default implementation in the base class is general but not efficient.
 
void AssembleElementGrad (const FiniteElement &el, ElementTransformation &Tr, const Vector &elfun, DenseMatrix &elmat) override
 Assemble the local gradient matrix.
 
void AssembleFaceGrad (const FiniteElement &el1, const FiniteElement &el2, FaceElementTransformations &Tr, const Vector &elfun, DenseMatrix &elmat) override
 Assemble the local action of the gradient of the NonlinearFormIntegrator resulting from a face integral term.
 
virtual void ComputeElementFlux (const FiniteElement &el, ElementTransformation &Trans, Vector &u, const FiniteElement &fluxelem, Vector &flux, bool with_coef=true, const IntegrationRule *ir=NULL)
 Virtual method required for Zienkiewicz-Zhu type error estimators.
 
virtual real_t ComputeFluxEnergy (const FiniteElement &fluxelem, ElementTransformation &Trans, Vector &flux, Vector *d_energy=NULL)
 Virtual method required for Zienkiewicz-Zhu type error estimators.
 
virtual bool RequiresFaceNormalDerivatives () const
 For bilinear forms on element faces, specifies if the normal derivatives are needed on the faces or just the face restriction.
 
virtual void AddMultPAFaceNormalDerivatives (const Vector &x, const Vector &dxdn, Vector &y, Vector &dydn) const
 Method for partially assembled action.
 
virtual ~BilinearFormIntegrator ()
 
- Public Member Functions inherited from mfem::NonlinearFormIntegrator
void SetIntegrationMode (Mode m)
 
bool Patchwise () const
 
void SetPAMemoryType (MemoryType mt)
 
virtual real_t GetElementEnergy (const FiniteElement &el, ElementTransformation &Tr, const Vector &elfun)
 Compute the local energy.
 
virtual void AssembleGradPA (const Vector &x, const FiniteElementSpace &fes)
 Prepare the integrator for partial assembly (PA) gradient evaluations on the given FE space fes at the state x.
 
virtual real_t GetLocalStateEnergyPA (const Vector &x) const
 Compute the local (to the MPI rank) energy with partial assembly.
 
virtual void AddMultGradPA (const Vector &x, Vector &y) const
 Method for partially assembled gradient action.
 
virtual void AssembleGradDiagonalPA (Vector &diag) const
 Method for computing the diagonal of the gradient with partial assembly.
 
ceed::OperatorGetCeedOp ()
 
virtual ~NonlinearFormIntegrator ()
 
- Public Member Functions inherited from mfem::Integrator
 Integrator (const IntegrationRule *ir=NULL)
 Create a new Integrator, optionally providing a prescribed quadrature rule to use in assembly.
 
virtual void SetIntRule (const IntegrationRule *ir)
 Prescribe a fixed IntegrationRule to use, or set to null to let the integrator choose an appropriate rule.
 
void SetIntegrationRule (const IntegrationRule &ir)
 Prescribe a fixed IntegrationRule to use. Sets the NURBS patch integration rule to null.
 
void SetNURBSPatchIntRule (NURBSMeshRules *pr)
 Sets an integration rule for use on NURBS patches.
 
bool HasNURBSPatchIntRule () const
 Check if a NURBS patch integration rule has been set.
 
const IntegrationRuleGetIntRule () const
 Directly return the IntRule pointer (possibly null) without checking for NURBS patch rules or falling back on a default.
 
const IntegrationRuleGetIntegrationRule () const
 Equivalent to GetIntRule, but retained for backward compatibility with applications.
 

Static Public Member Functions

static const IntegrationRuleGetRule (const FiniteElement &trial_fe, const FiniteElement &test_fe, const ElementTransformation &Trans)
 
template<int DIM, int D1D, int Q1D>
static void AddSpecialization ()
 

Protected Member Functions

void AssembleEA_ (Vector &ea, const bool add)
 
const IntegrationRuleGetDefaultIntegrationRule (const FiniteElement &trial_fe, const FiniteElement &test_fe, const ElementTransformation &trans) const override
 Subclasses should override to choose a default integration rule.
 
- Protected Member Functions inherited from mfem::BilinearFormIntegrator
 BilinearFormIntegrator (const IntegrationRule *ir=NULL)
 
- Protected Member Functions inherited from mfem::NonlinearFormIntegrator
 NonlinearFormIntegrator (const IntegrationRule *ir=NULL)
 
- Protected Member Functions inherited from mfem::Integrator
const IntegrationRuleGetIntegrationRule (const FiniteElement &trial_fe, const FiniteElement &test_fe, const ElementTransformation &trans) const
 Returns an integration rule based on the arguments and internal state of the Integrator object.
 
const IntegrationRuleGetIntegrationRule (const FiniteElement &el, const ElementTransformation &trans) const
 Returns an integration rule based on the arguments and internal state. (Version for identical trial_fe and test_fe)
 

Protected Attributes

Vector shape
 
Vector te_shape
 
CoefficientQ
 
const FiniteElementSpacefespace
 
Vector pa_data
 
const DofToQuadmaps
 Not owned.
 
const GeometricFactorsgeom
 Not owned.
 
const FaceGeometricFactorsface_geom
 Not owned.
 
int dim
 
int ne
 
int nq
 
int dofs1D
 
int quad1D
 
- Protected Attributes inherited from mfem::NonlinearFormIntegrator
Mode integrationMode = Mode::ELEMENTWISE
 
ceed::OperatorceedOp
 
MemoryType pa_mt = MemoryType::DEFAULT
 
- Protected Attributes inherited from mfem::Integrator
const IntegrationRuleIntRule
 
NURBSMeshRulespatchRules = nullptr
 

Friends

class DGMassInverse
 

Detailed Description

Class for local mass matrix assembling \(a(u,v) := (Q u, v)\)

Definition at line 2353 of file bilininteg.hpp.

Member Typedef Documentation

◆ ApplyKernelType

Initial value:
void(*)(const int, const Array<real_t>&,
const Array<real_t>&, const Vector&,
const Vector&, Vector&, const int, const int)

Definition at line 2373 of file bilininteg.hpp.

◆ DiagonalKernelType

Initial value:
void(*)(const int, const Array<real_t>&,
const Vector&, Vector&, const int,
const int)

Definition at line 2377 of file bilininteg.hpp.

Constructor & Destructor Documentation

◆ MassIntegrator() [1/2]

mfem::MassIntegrator::MassIntegrator ( const IntegrationRule * ir = nullptr)

Definition at line 1339 of file bilininteg.cpp.

◆ MassIntegrator() [2/2]

mfem::MassIntegrator::MassIntegrator ( Coefficient & q,
const IntegrationRule * ir = NULL )

Construct a mass integrator with coefficient q.

Definition at line 1345 of file bilininteg.cpp.

Member Function Documentation

◆ AddMultMF()

void mfem::MassIntegrator::AddMultMF ( const Vector & x,
Vector & y ) const
overridevirtual

Perform the action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssembleMF() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 46 of file bilininteg_mass_mf.cpp.

◆ AddMultPA()

void mfem::MassIntegrator::AddMultPA ( const Vector & x,
Vector & y ) const
overridevirtual

Method for partially assembled action.

Perform the action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssemblePA() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 204 of file bilininteg_mass_pa.cpp.

◆ AddMultTransposePA()

void mfem::MassIntegrator::AddMultTransposePA ( const Vector & x,
Vector & y ) const
overridevirtual

Method for partially assembled transposed action.

Perform the transpose action of integrator on the input x and add the result to the output y. Both x and y are E-vectors, i.e. they represent the element-wise discontinuous version of the FE space.

This method can be called only after the method AssemblePA() has been called.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 235 of file bilininteg_mass_pa.cpp.

◆ AddSpecialization()

template<int DIM, int D1D, int Q1D>
static void mfem::MassIntegrator::AddSpecialization ( )
inlinestatic

Definition at line 2433 of file bilininteg.hpp.

◆ AssembleDiagonalMF()

void mfem::MassIntegrator::AssembleDiagonalMF ( Vector & diag)
overridevirtual

Assemble diagonal and add it to Vector diag.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 59 of file bilininteg_mass_mf.cpp.

◆ AssembleDiagonalPA()

void mfem::MassIntegrator::AssembleDiagonalPA ( Vector & diag)
overridevirtual

Assemble diagonal and add it to Vector diag.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 191 of file bilininteg_mass_pa.cpp.

◆ AssembleEA()

void mfem::MassIntegrator::AssembleEA ( const FiniteElementSpace & fes,
Vector & emat,
const bool add )
overridevirtual

Method defining element assembly.

The result of the element assembly is added to the emat Vector if add is true. Otherwise, if add is false, we set emat.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 78 of file bilininteg_mass_ea.cpp.

◆ AssembleEA_()

void mfem::MassIntegrator::AssembleEA_ ( Vector & ea,
const bool add )
protected

Definition at line 20 of file bilininteg_mass_ea.cpp.

◆ AssembleEABoundary()

void mfem::MassIntegrator::AssembleEABoundary ( const FiniteElementSpace & fes,
Vector & emat,
const bool add )
overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 86 of file bilininteg_mass_ea.cpp.

◆ AssembleElementMatrix()

void mfem::MassIntegrator::AssembleElementMatrix ( const FiniteElement & el,
ElementTransformation & Trans,
DenseMatrix & elmat )
overridevirtual

Given a particular Finite Element computes the element mass matrix elmat.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 1351 of file bilininteg.cpp.

◆ AssembleElementMatrix2()

void mfem::MassIntegrator::AssembleElementMatrix2 ( const FiniteElement & trial_fe,
const FiniteElement & test_fe,
ElementTransformation & Trans,
DenseMatrix & elmat )
overridevirtual

Compute the local matrix representation of a bilinear form \(a(u,v)\) defined on different trial (given by \(u\)) and test (given by \(v\)) spaces. The rows in the local matrix correspond to the test dofs and the columns – to the trial dofs.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 1385 of file bilininteg.cpp.

◆ AssembleMF()

void mfem::MassIntegrator::AssembleMF ( const FiniteElementSpace & fes)
overridevirtual

Method defining matrix-free assembly.

Used with BilinearFormIntegrators that have different spaces. The result of fully matrix-free assembly is stored internally so that it can be used later in the methods AddMultMF() and AddMultTransposeMF().

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 19 of file bilininteg_mass_mf.cpp.

◆ AssemblePA() [1/2]

void mfem::MassIntegrator::AssemblePA ( const FiniteElementSpace & fes)
overridevirtual

Method defining partial assembly.

The result of the partial assembly is stored internally so that it can be used later in the methods AddMultPA() and AddMultTransposePA().

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 24 of file bilininteg_mass_pa.cpp.

◆ AssemblePA() [2/2]

void mfem::BilinearFormIntegrator::AssemblePA ( const FiniteElementSpace & trial_fes,
const FiniteElementSpace & test_fes )
overridevirtual

Used with BilinearFormIntegrators that have different spaces.

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 52 of file bilininteg.cpp.

◆ AssemblePABoundary()

void mfem::MassIntegrator::AssemblePABoundary ( const FiniteElementSpace & fes)
overridevirtual

Reimplemented from mfem::BilinearFormIntegrator.

Definition at line 117 of file bilininteg_mass_pa.cpp.

◆ GetCoefficient()

const Coefficient * mfem::MassIntegrator::GetCoefficient ( ) const
inline

Definition at line 2430 of file bilininteg.hpp.

◆ GetDefaultIntegrationRule()

const IntegrationRule * mfem::MassIntegrator::GetDefaultIntegrationRule ( const FiniteElement & trial_fe,
const FiniteElement & test_fe,
const ElementTransformation & trans ) const
inlineoverrideprotectedvirtual

Subclasses should override to choose a default integration rule.

This method is intended to be overridden by subclasses to choose an appropriate integration rule based on the finite element spaces and/or element transformation. The trial_fe and test_fe should be equal for linear forms. The default base-class implementation returns null, which assumes that an appropriate rule is provided by another means, or that null integration rules are handled appropriately by the caller.

Reimplemented from mfem::Integrator.

Definition at line 2440 of file bilininteg.hpp.

◆ GetRule()

const IntegrationRule & mfem::MassIntegrator::GetRule ( const FiniteElement & trial_fe,
const FiniteElement & test_fe,
const ElementTransformation & Trans )
static

Definition at line 1421 of file bilininteg.cpp.

◆ MFEM_REGISTER_KERNELS() [1/2]

mfem::MassIntegrator::MFEM_REGISTER_KERNELS ( ApplyPAKernels ,
ApplyKernelType ,
(int, int, int)  )

◆ MFEM_REGISTER_KERNELS() [2/2]

mfem::MassIntegrator::MFEM_REGISTER_KERNELS ( DiagonalPAKernels ,
DiagonalKernelType ,
(int, int, int)  )

◆ SupportsCeed()

bool mfem::MassIntegrator::SupportsCeed ( ) const
inlineoverridevirtual

Indicates whether this integrator can use a Ceed backend.

Reimplemented from mfem::NonlinearFormIntegrator.

Definition at line 2428 of file bilininteg.hpp.

Friends And Related Symbol Documentation

◆ DGMassInverse

friend class DGMassInverse
friend

Definition at line 2355 of file bilininteg.hpp.

Member Data Documentation

◆ dim

int mfem::MassIntegrator::dim
protected

Definition at line 2367 of file bilininteg.hpp.

◆ dofs1D

int mfem::MassIntegrator::dofs1D
protected

Definition at line 2367 of file bilininteg.hpp.

◆ face_geom

const FaceGeometricFactors* mfem::MassIntegrator::face_geom
protected

Not owned.

Definition at line 2366 of file bilininteg.hpp.

◆ fespace

const FiniteElementSpace* mfem::MassIntegrator::fespace
protected

Definition at line 2362 of file bilininteg.hpp.

◆ geom

const GeometricFactors* mfem::MassIntegrator::geom
protected

Not owned.

Definition at line 2365 of file bilininteg.hpp.

◆ maps

const DofToQuad* mfem::MassIntegrator::maps
protected

Not owned.

Definition at line 2364 of file bilininteg.hpp.

◆ ne

int mfem::MassIntegrator::ne
protected

Definition at line 2367 of file bilininteg.hpp.

◆ nq

int mfem::MassIntegrator::nq
protected

Definition at line 2367 of file bilininteg.hpp.

◆ pa_data

Vector mfem::MassIntegrator::pa_data
protected

Definition at line 2363 of file bilininteg.hpp.

◆ Q

Coefficient* mfem::MassIntegrator::Q
protected

Definition at line 2360 of file bilininteg.hpp.

◆ quad1D

int mfem::MassIntegrator::quad1D
protected

Definition at line 2367 of file bilininteg.hpp.

◆ shape

Vector mfem::MassIntegrator::shape
protected

Definition at line 2358 of file bilininteg.hpp.

◆ te_shape

Vector mfem::MassIntegrator::te_shape
protected

Definition at line 2358 of file bilininteg.hpp.


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