LifeV
FEScalarField< MeshType, MapType > Class Template Reference

FEScalarField - This class gives an abstract implementation of a finite element scalar field. More...

#include <FEField.hpp>

+ Inheritance diagram for FEScalarField< MeshType, MapType >:
+ Collaboration diagram for FEScalarField< MeshType, MapType >:

Public Types

typedef MeshType mesh_Type
 
typedef MapType map_Type
 
typedef Real return_Type
 
typedef FEField< mesh_Type, map_Type, return_TypeFEField_Type
 
typedef FEField_Type::FESpacePtr_Type FESpacePtr_Type
 
typedef FEField_Type::vectorPtr_Type vectorPtr_Type
 
typedef FEField_Type::point_Type point_Type
 

Constructors and destructor

 FEScalarField ()
 Empty constructor for the class. More...
 
 FEScalarField (const FESpacePtr_Type &fESpace, const vectorPtr_Type &vector)
 Full constructor for the class. More...
 
 FEScalarField (const FESpacePtr_Type &fESpace, const MapEpetraType &mapType=Repeated)
 Constructor for the class without the vector. More...
 
 FEScalarField (const FEScalarField &field)
 Copy constructor. More...
 
virtual ~FEScalarField ()
 Virtual destructor. More...
 

Methods

virtual return_Type eval (const UInt &iElem, const point_Type &P, const Real &time=0.) const
 Eval function. More...
 

Additional Inherited Members

- Public Types inherited from FEField< MeshType, MapType, Real >
typedef MeshType mesh_Type
 
typedef MapType map_Type
 
typedef Real return_Type
 
typedef FESpace< mesh_Type, map_TypeFESpace_Type
 
typedef std::shared_ptr< FESpace_TypeFESpacePtr_Type
 
typedef VectorEpetra vector_Type
 
typedef std::shared_ptr< vector_TypevectorPtr_Type
 
typedef Vector3D point_Type
 
- Public Member Functions inherited from FEField< MeshType, MapType, Real >
 FEField ()
 Empty constructor for the class. More...
 
 FEField (const FESpacePtr_Type &fESpace, const vectorPtr_Type &vector)
 Full constructor for the class. More...
 
 FEField (const FESpacePtr_Type &fESpace, const MapEpetraType &mapType=Repeated)
 Constructor for the class without the vector. More...
 
 FEField (const FEField &field)
 Copy constructor. More...
 
virtual ~FEField ()
 Virtual destructor. More...
 
FEFieldoperator= (const FEField &field)
 
void setFESpacePtr (const FESpacePtr_Type &fESpace, const bool createVector=false, const MapEpetraType &mapType=Repeated)
 Set the FESpace. More...
 
void setVectorPtr (const vectorPtr_Type &vector)
 Set the epetra vector. More...
 
void setVector (const vector_Type &vector)
 Set the epetra vector. More...
 
void setUp (const FESpacePtr_Type &fESpace, const vectorPtr_Type &vector)
 Set both FESpace and vector. More...
 
void cleanField ()
 Clean the field. More...
 
const FESpace_TypegetFESpace () const
 Return the finite element space. More...
 
FESpace_TypegetFESpace ()
 Return the finite element space. More...
 
const FESpacePtr_TypegetFESpacePtr () const
 Return the pointer to the finite element space. More...
 
const vectorPtr_TypegetVectorPtr () const
 Return the vector where the value are stored. More...
 
vector_TypegetVector ()
 Return the vector where the value are stored. More...
 
const vector_TypegetVector () const
 Return the vector where the value are stored. More...
 
- Protected Attributes inherited from FEField< MeshType, MapType, Real >
FESpacePtr_Type M_FESpace
 Reference of the finite element space. More...
 
vectorPtr_Type M_vector
 Pointer of a vector where the value are stored. More...
 

Detailed Description

template<typename MeshType, typename MapType>
class LifeV::FEScalarField< MeshType, MapType >

FEScalarField - This class gives an abstract implementation of a finite element scalar field.

Author
A. Fumagalli aless.nosp@m.io.f.nosp@m.umaga.nosp@m.lli@.nosp@m.mail..nosp@m.poli.nosp@m.mi.it
M. Kern miche.nosp@m.l.ke.nosp@m.rn@in.nosp@m.ria..nosp@m.fr

This class, derived from FEField, implements the concept of a scalar field associated to a finite element space.

Definition at line 307 of file FEField.hpp.

Member Typedef Documentation

◆ mesh_Type

Definition at line 315 of file FEField.hpp.

◆ map_Type

typedef MapType map_Type

Definition at line 316 of file FEField.hpp.

◆ return_Type

typedef Real return_Type

Definition at line 317 of file FEField.hpp.

◆ FEField_Type

Definition at line 319 of file FEField.hpp.

◆ FESpacePtr_Type

Definition at line 321 of file FEField.hpp.

◆ vectorPtr_Type

Definition at line 322 of file FEField.hpp.

◆ point_Type

Definition at line 324 of file FEField.hpp.

Constructor & Destructor Documentation

◆ FEScalarField() [1/4]

FEScalarField ( )
inline

Empty constructor for the class.

Definition at line 332 of file FEField.hpp.

◆ FEScalarField() [2/4]

FEScalarField ( const FESpacePtr_Type fESpace,
const vectorPtr_Type vector 
)
inline

Full constructor for the class.

Parameters
fESpaceFinite element space where the field is defined.
vectorvector witch represent the solution.

Definition at line 340 of file FEField.hpp.

◆ FEScalarField() [3/4]

FEScalarField ( const FESpacePtr_Type fESpace,
const MapEpetraType mapType = Repeated 
)
inline

Constructor for the class without the vector.

Create the field with the input finite element space and a new vector. The type of the map of the vector is Repeated (default value) or Unique.

Parameters
fESpaceFinite element space where the field is defined.
mapTypeSpecify wether the map is Unique or Repeated. Default value: Repeated.

Definition at line 351 of file FEField.hpp.

◆ FEScalarField() [4/4]

FEScalarField ( const FEScalarField< MeshType, MapType > &  field)
inline

Copy constructor.

Parameters
fieldFinite element field to be copied.

Definition at line 359 of file FEField.hpp.

◆ ~FEScalarField()

virtual ~FEScalarField ( )
inlinevirtual

Virtual destructor.

Definition at line 364 of file FEField.hpp.

Member Function Documentation

◆ eval()

Real eval ( const UInt iElem,
const point_Type P,
const Real time = 0. 
) const
inlinevirtual

Eval function.

Evaluate the field on a given point in a given element.

Parameters
iElemElement id in the mesh.
pointPoint where the field is evaluated, vector format.
Returns
The scalar value of the field.

Implements FEField< MeshType, MapType, Real >.

Definition at line 389 of file FEField.hpp.


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