MFEM v4.9.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::future::FieldOperator< FIELD_ID > Class Template Reference

Base class for FieldOperators. More...

#include <fieldoperator.hpp>

Public Member Functions

constexpr FieldOperator (int size_on_qp=0)
 Constructor for the FieldOperator.
 

Static Public Member Functions

static constexpr int GetFieldId ()
 Get the field id this FieldOperator is attached to.
 

Public Attributes

int size_on_qp = -1
 Get the size on quadrature point for this FieldOperator.
 
int dim = -1
 Get the dimension of the FieldOperator.
 
int vdim = -1
 Get the vector dimension (number of components) of the FieldOperator.
 

Detailed Description

template<int FIELD_ID = -1>
class mfem::future::FieldOperator< FIELD_ID >

Base class for FieldOperators.

This class serves as a base for different FieldOperator types which can be applied to fields that are used with inputs to a quadrature point function. See DifferentialOperator.

Definition at line 24 of file fieldoperator.hpp.

Constructor & Destructor Documentation

◆ FieldOperator()

template<int FIELD_ID = -1>
mfem::future::FieldOperator< FIELD_ID >::FieldOperator ( int size_on_qp = 0)
inlineconstexpr

Constructor for the FieldOperator.

This constructor initializes the FieldOperator with it's size on quadrature points. The size on quadrature points has to be determined by the FieldOperator type, the dimension and the vector dimension (number of components). See the following examples

Scalar FiniteElementSpace with Value FieldOperator: size = vdim x dim x 1 = 1 x dim x 1 = dim

Vector FiniteElementSpace with Gradient FieldOperator: size = vdim x dim x dim = vdim x dim x dim = vdim * dim^2

ParameterSpace with Identity FieldOperator: size = vdim = vdim

Definition at line 42 of file fieldoperator.hpp.

Member Function Documentation

◆ GetFieldId()

template<int FIELD_ID = -1>
static constexpr int mfem::future::FieldOperator< FIELD_ID >::GetFieldId ( )
inlinestaticconstexpr

Get the field id this FieldOperator is attached to.

Definition at line 46 of file fieldoperator.hpp.

Member Data Documentation

◆ dim

template<int FIELD_ID = -1>
int mfem::future::FieldOperator< FIELD_ID >::dim = -1

Get the dimension of the FieldOperator.

Definition at line 52 of file fieldoperator.hpp.

◆ size_on_qp

template<int FIELD_ID = -1>
int mfem::future::FieldOperator< FIELD_ID >::size_on_qp = -1

Get the size on quadrature point for this FieldOperator.

Definition at line 49 of file fieldoperator.hpp.

◆ vdim

template<int FIELD_ID = -1>
int mfem::future::FieldOperator< FIELD_ID >::vdim = -1

Get the vector dimension (number of components) of the FieldOperator.

Definition at line 56 of file fieldoperator.hpp.


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