NonlinearFormIntegrator which scales its results by a constant value. More...

#include <NLScaleIntegrator.h>

Inheritance diagram for Moose::MFEM::NLScaleIntegrator:

Public Member Functions
	NLScaleIntegrator (mfem::NonlinearFormIntegrator *integ)

	NLScaleIntegrator (mfem::NonlinearFormIntegrator *integ, mfem::real_t scale)

	NLScaleIntegrator (mfem::NonlinearFormIntegrator *integ, mfem::real_t scale, bool own)

void	SetIntegrator (mfem::NonlinearFormIntegrator *integ)

void	SetScale (mfem::real_t scale)

void	SetOwn (bool own)

void	CheckIntegrator ()

void	SetIntegrationMode (mfem::NonlinearFormIntegrator::Mode m)

bool	Patchwise () const

void	SetPAMemoryType (mfem::MemoryType mt)
	Set the memory type used for GeometricFactors and other large allocations in PA extensions. More...

virtual void	AssembleElementVector (const mfem::FiniteElement &el, mfem::ElementTransformation &Tr, const mfem::Vector &elfun, mfem::Vector &elvect) override

virtual void	AssembleFaceVector (const mfem::FiniteElement &el1, const mfem::FiniteElement &el2, mfem::FaceElementTransformations &Tr, const mfem::Vector &elfun, mfem::Vector &elvect) override

virtual void	AssembleElementGrad (const mfem::FiniteElement &el, mfem::ElementTransformation &Tr, const mfem::Vector &elfun, mfem::DenseMatrix &elmat) override

virtual void	AssembleFaceGrad (const mfem::FiniteElement &el1, const mfem::FiniteElement &el2, mfem::FaceElementTransformations &Tr, const mfem::Vector &elfun, mfem::DenseMatrix &elmat) override

virtual mfem::real_t	GetElementEnergy (const mfem::FiniteElement &el, mfem::ElementTransformation &Tr, const mfem::Vector &elfun) override

virtual	~NLScaleIntegrator ()

Private Attributes
mfem::NonlinearFormIntegrator *	_integrator {nullptr}

mfem::real_t	_scale

bool	_own_integrator

Detailed Description

NonlinearFormIntegrator which scales its results by a constant value.

Definition at line 24 of file NLScaleIntegrator.h.

Constructor & Destructor Documentation

◆ NLScaleIntegrator() [1/3]

Moose::MFEM::NLScaleIntegrator::NLScaleIntegrator ( mfem::NonlinearFormIntegrator * integ )

inline

Definition at line 32 of file NLScaleIntegrator.h.

     : _integrator{integ}, _scale{1}, _own_integrator{true}
   {
   }

◆ NLScaleIntegrator() [2/3]

Moose::MFEM::NLScaleIntegrator::NLScaleIntegrator	(	mfem::NonlinearFormIntegrator *	integ,
		mfem::real_t	scale
	)

inline

Definition at line 36 of file NLScaleIntegrator.h.

     : _integrator{integ}, _scale{scale}, _own_integrator{true}
   {
   }

◆ NLScaleIntegrator() [3/3]

Moose::MFEM::NLScaleIntegrator::NLScaleIntegrator	(	mfem::NonlinearFormIntegrator *	integ,
		mfem::real_t	scale,
		bool	own
	)

inline

Definition at line 40 of file NLScaleIntegrator.h.

     : _integrator{integ}, _scale{scale}, _own_integrator{own}
   {
   }

◆ ~NLScaleIntegrator()

virtual Moose::MFEM::NLScaleIntegrator::~NLScaleIntegrator ( )

inlinevirtual

Definition at line 107 of file NLScaleIntegrator.h.

   {
     if (_own_integrator)
       delete _integrator;
   };

Member Function Documentation

◆ AssembleElementGrad()

void Moose::MFEM::NLScaleIntegrator::AssembleElementGrad	(	const mfem::FiniteElement &	el,
		mfem::ElementTransformation &	Tr,
		const mfem::Vector &	elfun,
		mfem::DenseMatrix &	elmat
	)

overridevirtual

Definition at line 41 of file NLScaleIntegrator.C.

 {
   CheckIntegrator();
   _integrator->AssembleElementGrad(el, Tr, elfun, elmat);
   elmat *= _scale;
 }

◆ AssembleElementVector()

void Moose::MFEM::NLScaleIntegrator::AssembleElementVector	(	const mfem::FiniteElement &	el,
		mfem::ElementTransformation &	Tr,
		const mfem::Vector &	elfun,
		mfem::Vector &	elvect
	)

overridevirtual

Definition at line 18 of file NLScaleIntegrator.C.

 {
   CheckIntegrator();
   _integrator->AssembleElementVector(el, Tr, elfun, elvect);
   elvect *= _scale;
 }

◆ AssembleFaceGrad()

void Moose::MFEM::NLScaleIntegrator::AssembleFaceGrad	(	const mfem::FiniteElement &	el1,
		const mfem::FiniteElement &	el2,
		mfem::FaceElementTransformations &	Tr,
		const mfem::Vector &	elfun,
		mfem::DenseMatrix &	elmat
	)

overridevirtual

Definition at line 52 of file NLScaleIntegrator.C.

 {
   CheckIntegrator();
   _integrator->AssembleFaceGrad(el1, el2, Tr, elfun, elmat);
   elmat *= _scale;
 }

◆ AssembleFaceVector()

void Moose::MFEM::NLScaleIntegrator::AssembleFaceVector	(	const mfem::FiniteElement &	el1,
		const mfem::FiniteElement &	el2,
		mfem::FaceElementTransformations &	Tr,
		const mfem::Vector &	elfun,
		mfem::Vector &	elvect
	)

overridevirtual

Definition at line 29 of file NLScaleIntegrator.C.

 {
   CheckIntegrator();
   _integrator->AssembleFaceVector(el1, el2, Tr, elfun, elvect);
   elvect *= _scale;
 }

◆ CheckIntegrator()

void Moose::MFEM::NLScaleIntegrator::CheckIntegrator ( )

inline

Definition at line 59 of file NLScaleIntegrator.h.

Referenced by AssembleElementGrad(), AssembleElementVector(), AssembleFaceGrad(), AssembleFaceVector(), and GetElementEnergy().

   {
     if (!_integrator)
       mooseError("Integrator not set");
   }

◆ GetElementEnergy()

mfem::real_t Moose::MFEM::NLScaleIntegrator::GetElementEnergy	(	const mfem::FiniteElement &	el,
		mfem::ElementTransformation &	Tr,
		const mfem::Vector &	elfun
	)

overridevirtual

Definition at line 64 of file NLScaleIntegrator.C.

 {
   CheckIntegrator();
   return _scale * _integrator->GetElementEnergy(el, Tr, elfun);
 }

◆ Patchwise()

bool Moose::MFEM::NLScaleIntegrator::Patchwise ( ) const

inline

Definition at line 71 of file NLScaleIntegrator.h.

71 { return integrationMode != Mode::ELEMENTWISE; }

◆ SetIntegrationMode()

void Moose::MFEM::NLScaleIntegrator::SetIntegrationMode ( mfem::NonlinearFormIntegrator::Mode m )

inline

Definition at line 65 of file NLScaleIntegrator.h.

   {
     integrationMode = m;
     _integrator->SetIntegrationMode(m);
   }

◆ SetIntegrator()

void Moose::MFEM::NLScaleIntegrator::SetIntegrator ( mfem::NonlinearFormIntegrator * integ )

inline

Definition at line 45 of file NLScaleIntegrator.h.

   {
     if (_integrator && _own_integrator)
     {
       delete _integrator;
     }
 
     _integrator = integ;
   }

◆ SetOwn()

void Moose::MFEM::NLScaleIntegrator::SetOwn ( bool own )

inline

Definition at line 57 of file NLScaleIntegrator.h.

57 { _own_integrator = own; }

Moose::MFEM::NLScaleIntegrator::_own_integrator

bool _own_integrator

Definition: NLScaleIntegrator.h:29

◆ SetPAMemoryType()

void Moose::MFEM::NLScaleIntegrator::SetPAMemoryType ( mfem::MemoryType mt )

inline

Set the memory type used for GeometricFactors and other large allocations in PA extensions.

Definition at line 75 of file NLScaleIntegrator.h.

   {
     pa_mt = mt;
     _integrator->SetPAMemoryType(mt);
   }

◆ SetScale()

void Moose::MFEM::NLScaleIntegrator::SetScale ( mfem::real_t scale )

inline

Definition at line 55 of file NLScaleIntegrator.h.

55 { _scale = scale; }

scale

void scale(MeshBase &mesh, const Real xs, const Real ys=0., const Real zs=0.)

Moose::MFEM::NLScaleIntegrator::_scale

mfem::real_t _scale

Definition: NLScaleIntegrator.h:28

Member Data Documentation

◆ _integrator

mfem::NonlinearFormIntegrator* Moose::MFEM::NLScaleIntegrator::_integrator {nullptr}

private

Definition at line 27 of file NLScaleIntegrator.h.

Referenced by AssembleElementGrad(), AssembleElementVector(), AssembleFaceGrad(), AssembleFaceVector(), CheckIntegrator(), GetElementEnergy(), SetIntegrationMode(), SetIntegrator(), SetPAMemoryType(), and ~NLScaleIntegrator().

◆ _own_integrator

bool Moose::MFEM::NLScaleIntegrator::_own_integrator

private

Definition at line 29 of file NLScaleIntegrator.h.

Referenced by SetIntegrator(), SetOwn(), and ~NLScaleIntegrator().

◆ _scale

mfem::real_t Moose::MFEM::NLScaleIntegrator::_scale

private

Definition at line 28 of file NLScaleIntegrator.h.

Referenced by AssembleElementGrad(), AssembleElementVector(), AssembleFaceGrad(), AssembleFaceVector(), GetElementEnergy(), and SetScale().

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

include/mfem/integrators/NLScaleIntegrator.h
src/mfem/integrators/NLScaleIntegrator.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NLScaleIntegrator() [1/3]

◆ NLScaleIntegrator() [2/3]

◆ NLScaleIntegrator() [3/3]

◆ ~NLScaleIntegrator()

Member Function Documentation

◆ AssembleElementGrad()

◆ AssembleElementVector()

◆ AssembleFaceGrad()

◆ AssembleFaceVector()

◆ CheckIntegrator()

◆ GetElementEnergy()

◆ Patchwise()

◆ SetIntegrationMode()

◆ SetIntegrator()

◆ SetOwn()

◆ SetPAMemoryType()

◆ SetScale()

Member Data Documentation

◆ _integrator

◆ _own_integrator

◆ _scale