default operator for TET element More...

#include <src/finite_elements/VolumeElementForcesAndSourcesCore.hpp>

Inheritance diagram for MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator:

Collaboration diagram for MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator:

Public Member Functions
int	getNumNodes ()
	get element number of nodes More...

const EntityHandle *	getConn ()
	get element connectivity More...

double	getVolume () const
	element volume (linear geometry) More...

double &	getVolume ()
	element volume (linear geometry) More...

FTensor::Tensor2< double *, 3, 3 > &	getJac ()
	get element Jacobian More...

FTensor::Tensor2< double *, 3, 3 > &	getInvJac ()
	get element inverse Jacobian More...

double	getMeasure () const
	get measure of element More...

double &	getMeasure ()
	get measure of element More...

VectorDouble &	getCoords ()
	nodal coordinates More...

MatrixDouble &	getCoordsAtGaussPts ()
	Gauss points and weight, matrix (nb. of points x 3) More...

MatrixDouble &	getHoCoordsAtGaussPts ()
	coordinate at Gauss points (if hierarchical approximation of element geometry) More...

MatrixDouble &	getHoGaussPtsJac ()

MatrixDouble &	getHoGaussPtsInvJac ()

VectorDouble &	getHoGaussPtsDetJac ()

auto	getFTenosr0HoMeasure ()

auto	getFTensor1CoordsAtGaussPts ()
	Get coordinates at integration points assuming linear geometry. More...

auto	getFTensor1HoCoordsAtGaussPts ()
	Get coordinates at integration points taking geometry from field. More...

auto	getFTensor2HoGaussPtsJac ()

auto	getFTensor2HoGaussPtsInvJac ()

VolumeElementForcesAndSourcesCoreBase *	getVolumeFE () const
	return pointer to Generic Volume Finite Element object More...

MoFEMErrorCode	getDivergenceOfHDivBaseFunctions (int side, EntityType type, DataForcesAndSourcesCore::EntData &data, int gg, VectorDouble &div)
	Get divergence of base functions at integration point. More...

MoFEMErrorCode	getCurlOfHCurlBaseFunctions (int side, EntityType type, DataForcesAndSourcesCore::EntData &data, int gg, MatrixDouble &curl)
	Get curl of base functions at integration point. More...

Public Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
	UserDataOperator (const FieldSpace space, const char type=OPLAST, const bool symm=true)

	UserDataOperator (const std::string &field_name, const char type, const bool symm=true)

	UserDataOperator (const std::string &row_field_name, const std::string &col_field_name, const char type, const bool symm=true)

boost::shared_ptr< const NumeredEntFiniteElement >	getNumeredEntFiniteElementPtr () const
	Return raw pointer to NumeredEntFiniteElement. More...

EntityHandle	getFEEntityHandle () const
	Return finite element entity handle. More...

boost::weak_ptr< SideNumber >	getSideNumberPtr (const int side_number, const EntityType type)
	Get the side number pointer. More...

EntityHandle	getSideEntity (const int side_number, const EntityType type)
	Get the side entity. More...

int	getNumberOfNodesOnElement ()
	Get the number of nodes on finite element. More...

MoFEMErrorCode	getProblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get row indices. More...

MoFEMErrorCode	getProblemColIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get col indices. More...

const FEMethod *	getFEMethod () const
	Return raw pointer to Finite Element Method object. More...

int	getOpType () const
	Get operator types. More...

void	setOpType (const OpType type)
	Set operator type. More...

void	addOpType (const OpType type)
	Add operator type. More...

int	getNinTheLoop () const
	get number of finite element in the loop More...

int	getLoopSize () const
	get size of elements in the loop More...

const std::string &	getFEName () const
	Get name of the element. More...

const PetscData::Switches &	getDataCtx () const

const KspMethod::KSPContext	getKSPCtx () const

const SnesMethod::SNESContext	getSNESCtx () const

const TSMethod::TSContext	getTSCtx () const

Vec	getKSPf () const

Mat	getKSPA () const

Mat	getKSPB () const

Vec	getSNESf () const

Vec	getSNESx () const

Mat	getSNESA () const

Mat	getSNESB () const

DEPRECATED Vec	getSnesF () const

DEPRECATED Vec	getSnesX () const

DEPRECATED Mat	getSnesA () const

DEPRECATED Mat	getSnesB () const

Vec	getTSu () const

Vec	getTSu_t () const

Vec	getTSu_tt () const

Vec	getTSf () const

Mat	getTSA () const

Mat	getTSB () const

int	getTSstep () const

double	getTStime () const

double	getTSa () const

double	getTSaa () const

MatrixDouble &	getGaussPts ()
	matrix of integration (Gauss) points for Volume Element More...

auto	getFTensor0IntegrationWeight ()
	Get integration weights. More...

DEPRECATED MoFEMErrorCode	getPorblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const

Public Member Functions inherited from MoFEM::DataOperator
	DataOperator (const bool symm=true)

virtual	~DataOperator ()=default

virtual MoFEMErrorCode	doWork (int row_side, int col_side, EntityType row_type, EntityType col_type, DataForcesAndSourcesCore::EntData &row_data, DataForcesAndSourcesCore::EntData &col_data)
	Operator for bi-linear form, usually to calculate values on left hand side. More...

virtual MoFEMErrorCode	opLhs (DataForcesAndSourcesCore &row_data, DataForcesAndSourcesCore &col_data)

virtual MoFEMErrorCode	doWork (int side, EntityType type, DataForcesAndSourcesCore::EntData &data)
	Operator for linear form, usually to calculate values on right hand side. More...

virtual MoFEMErrorCode	opRhs (DataForcesAndSourcesCore &data, const bool error_if_no_base=false)

bool	getSymm () const
	Get if operator uses symmetry of DOFs or not. More...

void	setSymm ()
	set if operator is executed taking in account symmetry More...

void	unSetSymm ()
	unset if operator is executed for non symmetric problem More...

Protected Member Functions
MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)

Protected Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
ForcesAndSourcesCore *	getPtrFE () const

ForcesAndSourcesCore *	getSidePtrFE () const

Additional Inherited Members
Public Types inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
enum	OpType { OPROW = 1 << 0 , OPCOL = 1 << 1 , OPROWCOL = 1 << 2 , OPLAST = 1 << 3 }
	Controls loop over entities on element. More...

Public Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
char	opType

std::string	rowFieldName

std::string	colFieldName

FieldSpace	sPace

Public Attributes inherited from MoFEM::DataOperator
bool	sYmm
	If true assume that matrix is symmetric structure. More...

std::array< bool, MBMAXTYPE >	doEntities
	If true operator is executed for entity. More...

bool &	doVertices
	\deprectaed If false skip vertices More...

bool &	doEdges
	\deprectaed If false skip edges More...

bool &	doQuads
	\deprectaed More...

bool &	doTris
	\deprectaed More...

bool &	doTets
	\deprectaed More...

bool &	doPrisms
	\deprectaed More...

Protected Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
ForcesAndSourcesCore *	ptrFE

Detailed Description

default operator for TET element

Definition at line 45 of file VolumeElementForcesAndSourcesCore.hpp.

Member Function Documentation

◆ getConn()

const EntityHandle * MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getConn ( )

get element connectivity

Definition at line 398 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->conn;
 }

◆ getCoords()

VectorDouble & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getCoords ( )

nodal coordinates

Definition at line 431 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                  {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->coords;
 }

◆ getCoordsAtGaussPts()

MatrixDouble & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getCoordsAtGaussPts ( )

Gauss points and weight, matrix (nb. of points x 3)

Column 0-2 integration points coordinate x, y and z, respectively. At rows are integration points.

Examples: UnsaturatedFlow.hpp.

Definition at line 436 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                            {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)
       ->coordsAtGaussPts;
 }

◆ getCurlOfHCurlBaseFunctions()

MoFEMErrorCode MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getCurlOfHCurlBaseFunctions	(	int	side,
		EntityType	type,
		DataForcesAndSourcesCore::EntData &	data,
		int	gg,
		MatrixDouble &	curl
	)

Get curl of base functions at integration point.

\[ \nabla \times \mathbf{\phi} \]

Works only for H-curl and H-div space.

How to use it:

MatrixDouble curl_mat(data.getFieldData().size(),3);
for(int gg = 0;gg<nb_gauss_pts;gg++) {
 CHKERR getCurlOfHCurlBaseFunctions(side,type,data,gg,curl_mat);
 FTensor::Tensor1<FTensor::PackPtr<double*, 3>, 3> t_curl(
   &curl_mat(0,0), &curl_mat(0,1), &curl_mat(0,2)
 );
 // do something with curl
}

where curl_mat is matrix which number of rows is equal to nb. of base functions. Number of columns is 3, since we work in 3d here. Rows represents curl of base functions.

Parameters

side	side (local) number of entity on element
type	type of entity
data	data structure
gg	gauss pts
curl	curl matrix, nb. of rows is equal to number of base functions, columns are curl of base vector

Returns: error code

Examples: MagneticElement.hpp.

Definition at line 379 of file VolumeElementForcesAndSourcesCore.cpp.

                                                     {
   MoFEMFunctionBegin;
  
   int nb_dofs = data.getFieldData().size();
   if (nb_dofs == 0)
     MoFEMFunctionReturnHot(0);
  
   if (data.getSpace() != HDIV && data.getSpace() != HCURL) {
     SETERRQ1(getVolumeFE()->mField.get_comm(), MOFEM_DATA_INCONSISTENCY,
              "This function should be used for primarily for HCURL"
              " but will work with HDIV used but is used with %s",
              FieldSpaceNames[data.getSpace()]);
   }
  
   if ((unsigned int)nb_dofs != data.getDiffN().size2() / 9) {
     SETERRQ3(getVolumeFE()->mField.get_comm(), MOFEM_DATA_INCONSISTENCY,
              "Data insistency, wrong number of dofs  = %s "
              "%d != %d/9",
              FieldSpaceNames[data.getSpace()], nb_dofs,
              data.getDiffN().size2());
   }
  
   curl.resize(nb_dofs, 3, false);
   FTensor::Tensor1<FTensor::PackPtr<double *, 3>, 3> t_curl(
       &curl(0, 0), &curl(0, 1), &curl(0, 2));
   const double *grad_ptr = &data.getDiffN()(gg, 0);
  
   FTensor::Tensor2<FTensor::PackPtr<const double *, 9>, 3, 3> t_grad_base(
       grad_ptr, &grad_ptr[HVEC0_1], &grad_ptr[HVEC0_2], &grad_ptr[HVEC1_0],
       &grad_ptr[HVEC1_1], &grad_ptr[HVEC1_2], &grad_ptr[HVEC2_0],
       &grad_ptr[HVEC2_1], &grad_ptr[HVEC2_2]);
   for (int dd = 0; dd != nb_dofs; ++dd) {
     t_curl(0) = t_grad_base(2, 1) - t_grad_base(1, 2);
     t_curl(1) = t_grad_base(0, 2) - t_grad_base(2, 0);
     t_curl(2) = t_grad_base(1, 0) - t_grad_base(0, 1);
     ++t_curl;
     ++t_grad_base;
   }
  
   MoFEMFunctionReturn(0);
 }

◆ getDivergenceOfHDivBaseFunctions()

MoFEMErrorCode MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getDivergenceOfHDivBaseFunctions	(	int	side,
		EntityType	type,
		DataForcesAndSourcesCore::EntData &	data,
		int	gg,
		VectorDouble &	div
	)

Get divergence of base functions at integration point.

Works only for H-div space.

How to use it:

VectorDouble div_vec(data.getFieldData().size());
for(int gg = 0;gg<nb_gauss_pts;gg++) {
 CHKERR getDivergenceOfHDivBaseFunctions(side,type,data,gg,div_vec);
 // do something with vec_div
}

where vec_div has size of nb. of dofs, at each element represents divergence of base functions.

Parameters

side	side (local) number of entity on element
type	type of entity
data	data structure
gg	gauss pts
div	divergence vector, size of vector is equal to number of base functions

Returns: error code

Examples: UnsaturatedFlow.hpp.

Definition at line 340 of file VolumeElementForcesAndSourcesCore.cpp.

                                                                 {
   MoFEMFunctionBegin;
  
   int nb_dofs = data.getFieldData().size();
   if (nb_dofs == 0)
     MoFEMFunctionReturnHot(0);
  
   if (data.getSpace() != HDIV && data.getSpace() != HCURL) {
     SETERRQ1(getVolumeFE()->mField.get_comm(), MOFEM_DATA_INCONSISTENCY,
              "This function should be used for HDIV used but is used with %s",
              FieldSpaceNames[data.getSpace()]);
   }
  
   if ((unsigned int)nb_dofs != data.getDiffN().size2() / 9) {
     SETERRQ3(getVolumeFE()->mField.get_comm(), MOFEM_DATA_INCONSISTENCY,
              "Data inositency, wrong number of dofs  = %s "
              "%d != %d/9",
              FieldSpaceNames[data.getSpace()], nb_dofs,
              data.getDiffN().size2());
   }
  
   div.resize(nb_dofs, false);
  
   FTensor::Tensor0<double *> t_div(&*div.data().begin());
   const double *grad_ptr = &data.getDiffN()(gg, 0);
   FTensor::Tensor1<FTensor::PackPtr<const double *, 9>, 3> t_grad_base(
       grad_ptr, &grad_ptr[HVEC1_1], &grad_ptr[HVEC2_2]);
   for (int dd = 0; dd < nb_dofs; dd++) {
     t_div = t_grad_base(0) + t_grad_base(1) + t_grad_base(2);
     ++t_div;
     ++t_grad_base;
   }
  
   MoFEMFunctionReturn(0);
 }

◆ getFTenosr0HoMeasure()

auto MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getFTenosr0HoMeasure ( )

Definition at line 465 of file VolumeElementForcesAndSourcesCore.hpp.

                            {
   return FTensor::Tensor0<FTensor::PackPtr<double *, 1>>(
       &*getHoGaussPtsDetJac().data().begin());
 }

◆ getFTensor1CoordsAtGaussPts()

auto MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getFTensor1CoordsAtGaussPts ( )

Get coordinates at integration points assuming linear geometry.

auto t_coords = getFTensor1CoordsAtGaussPts();
for(int gg = 0;gg!=nb_int_ptrs;gg++) {
  // do something
  ++t_coords;
}

Examples: UnsaturatedFlow.hpp, and prism_polynomial_approximation.cpp.

Definition at line 471 of file VolumeElementForcesAndSourcesCore.hpp.

                                   {
   return FTensor::Tensor1<FTensor::PackPtr<double *, 3>, 3>(
       &getCoordsAtGaussPts()(0, 0), &getCoordsAtGaussPts()(0, 1),
       &getCoordsAtGaussPts()(0, 2));
 }

◆ getFTensor1HoCoordsAtGaussPts()

auto MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getFTensor1HoCoordsAtGaussPts ( )

Get coordinates at integration points taking geometry from field.

This is HO geometry given by arbitrary order polynomial

auto t_coords = getFTensor1HoCoordsAtGaussPts();
for(int gg = 0;gg!=nb_int_ptrs;gg++) {
  // do something
  ++t_coords;
}

Definition at line 478 of file VolumeElementForcesAndSourcesCore.hpp.

                                     {
   double *ptr = &*getHoCoordsAtGaussPts().data().begin();
   return FTensor::Tensor1<FTensor::PackPtr<double *, 3>, 3>(ptr, ptr + 1,
                                                             ptr + 2);
 }

◆ getFTensor2HoGaussPtsInvJac()

auto MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getFTensor2HoGaussPtsInvJac ( )

Definition at line 493 of file VolumeElementForcesAndSourcesCore.hpp.

                                   {
   double *ptr = &*getHoGaussPtsInvJac().data().begin();
   FTensor::Tensor2<FTensor::PackPtr<double *, 9>, 3, 3> jac(
       ptr, ptr + 1, ptr + 2, ptr + 3, ptr + 4, ptr + 5, ptr + 6, ptr + 7,
       ptr + 8);
 }

◆ getFTensor2HoGaussPtsJac()

auto MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getFTensor2HoGaussPtsJac ( )

Definition at line 485 of file VolumeElementForcesAndSourcesCore.hpp.

                                {
   double *ptr = &*getHoGaussPtsJac().data().begin();
   FTensor::Tensor2<FTensor::PackPtr<double *, 9>, 3, 3> jac(
       ptr, ptr + 1, ptr + 2, ptr + 3, ptr + 4, ptr + 5, ptr + 6, ptr + 7,
       ptr + 8);
 }

◆ getHoCoordsAtGaussPts()

MatrixDouble & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getHoCoordsAtGaussPts ( )

coordinate at Gauss points (if hierarchical approximation of element geometry)

Definition at line 441 of file VolumeElementForcesAndSourcesCore.hpp.

                             {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)
       ->hoCoordsAtGaussPts;
 }

◆ getHoGaussPtsDetJac()

VectorDouble & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getHoGaussPtsDetJac ( )

Examples: MagneticElement.hpp.

Definition at line 460 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                            {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)
       ->hoGaussPtsDetJac;
 }

◆ getHoGaussPtsInvJac()

MatrixDouble & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getHoGaussPtsInvJac ( )

Definition at line 454 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                            {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)
       ->hoGaussPtsInvJac;
 }

◆ getHoGaussPtsJac()

MatrixDouble & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getHoGaussPtsJac ( )

Definition at line 448 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                         {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)
       ->hoGaussPtsJac;
 }

◆ getInvJac()

FTensor::Tensor2< double *, 3, 3 > & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getInvJac ( )

get element inverse Jacobian

Definition at line 417 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                  {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->tInvJac;
 }

◆ getJac()

FTensor::Tensor2< double *, 3, 3 > & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getJac ( )

get element Jacobian

Definition at line 412 of file VolumeElementForcesAndSourcesCore.hpp.

                                                               {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->tJac;
 }

◆ getMeasure() [1/2]

double & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getMeasure ( )

get measure of element

Returns: volume

Definition at line 426 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                           {
   return getVolume();
 }

◆ getMeasure() [2/2]

double MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getMeasure ( ) const

get measure of element

Returns: volume

Examples: PlasticOps.hpp, and heat_method.cpp.

Definition at line 422 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                         {
   return getVolume();
 }

◆ getNumNodes()

int MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getNumNodes ( )

get element number of nodes

Definition at line 393 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                        {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->num_nodes;
 }

◆ getVolume() [1/2]

double & MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getVolume ( )

element volume (linear geometry)

Definition at line 407 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                          {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->vOlume;
 }

◆ getVolume() [2/2]

double MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getVolume ( ) const

element volume (linear geometry)

Examples: MagneticElement.hpp, UnsaturatedFlow.hpp, and prism_polynomial_approximation.cpp.

Definition at line 403 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                        {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE)->vOlume;
 }

◆ getVolumeFE()

VolumeElementForcesAndSourcesCoreBase * MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::getVolumeFE ( ) const

return pointer to Generic Volume Finite Element object

Definition at line 502 of file VolumeElementForcesAndSourcesCore.hpp.

                                                                          {
   return static_cast<VolumeElementForcesAndSourcesCoreBase *>(ptrFE);
 }

◆ setPtrFE()

MoFEMErrorCode MoFEM::VolumeElementForcesAndSourcesCoreBase::UserDataOperator::setPtrFE ( ForcesAndSourcesCore * ptr )

protectedvirtual

Reimplemented from MoFEM::ForcesAndSourcesCore::UserDataOperator.

Reimplemented in MoFEM::VolumeElementForcesAndSourcesCoreOnSideBase::UserDataOperator.

Definition at line 425 of file VolumeElementForcesAndSourcesCore.cpp.

                                {
   MoFEMFunctionBeginHot;
   if(!(ptrFE = dynamic_cast<VolumeElementForcesAndSourcesCoreBase *>(ptr))) 
     SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
             "User operator and finite element do not work together");
   MoFEMFunctionReturnHot(0);
 }

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

src/finite_elements/VolumeElementForcesAndSourcesCore.hpp
src/finite_elements/impl/VolumeElementForcesAndSourcesCore.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members