MoFEM::ForcesAndSourcesCore::UserDataOperator Struct Reference

Data operator to do calculations at integration points.Is inherited and implemented by user to do calculations. It can be used in many different ways but typically is used to integrate matrices (f.e. stiffness matrix) and the right hand vector (f.e. force vector). More...

#include <src/finite_elements/ForcesAndSourcesCore.hpp>

Inheritance diagram for MoFEM::ForcesAndSourcesCore::UserDataOperator:

Collaboration diagram for MoFEM::ForcesAndSourcesCore::UserDataOperator:

Public Types
enum	OpType { OPROW = 1 << 0, OPCOL = 1 << 1, OPROWCOL = 1 << 2, OPLAST = 1 << 3 }
	Controls loop over entities on element. More...

Public Member Functions
	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)
virtual	~UserDataOperator ()
boost::shared_ptr< const NumeredEntFiniteElement >	getNumeredEntFiniteElementPtr () const
	Return raw pointer to NumeredEntFiniteElement. More...
EntityHandle	getFEEntityHandle () const
	Return finite element entity handle. More...
MoFEMErrorCode	getProblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get row indices. More...
DEPRECATED MoFEMErrorCode	getPorblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
MoFEMErrorCode	getProblemColIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
	Get col indices. More...
virtual MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)
DEPRECATED MoFEMErrorCode	getPorblemColIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
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...
Accessing SNES
Vec	getSnesF () const
Vec	getSnesX () const
Mat	getSnesA () const
Mat	getSnesB () const
Accessing TS
Vec	getTSu () const
Vec	getTSu_t () const
Vec	getTSf () const
Mat	getTSA () const
Mat	getTSB () const
int	getTSstep () const
double	getTStime () const
double	getTSa () const
Base funtions and integration points
MatrixDouble &	getGaussPts ()
	matrix of integration (Gauss) points for Volume Element More...
auto	getFTensor0IntegrationWeight ()
	Get integration weights. More...
Public Member Functions inherited from MoFEM::DataOperator
	DataOperator (const bool symm=true, const bool do_vertices=true, const bool do_edges=true, const bool do_quads=true, const bool do_tris=true, const bool do_tets=true, const bool do_prisms=true)
virtual	~DataOperator ()
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 right hand side. More...
virtual MoFEMErrorCode	opLhs (DataForcesAndSourcesCore &row_data, DataForcesAndSourcesCore &col_data, bool symm=true)
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 left hand side. More...
virtual MoFEMErrorCode	opRhs (DataForcesAndSourcesCore &data, const bool do_vertices, const bool do_edges, const bool do_quads, const bool do_tris, const bool do_tets, const bool do_prisms, const bool error_if_no_base=true)
virtual MoFEMErrorCode	opRhs (DataForcesAndSourcesCore &data, const bool error_if_no_base=true)
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...

Public Attributes
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...
bool	doVertices
	If false skip vertices. More...
bool	doEdges
	If false skip edges. More...
bool	doQuads
bool	doTris
bool	doTets
bool	doPrisms

Protected Attributes
ForcesAndSourcesCore *	ptrFE

Detailed Description

Data operator to do calculations at integration points.

Is inherited and implemented by user to do calculations. It can be used in many different ways but typically is used to integrate matrices (f.e. stiffness matrix) and the right hand vector (f.e. force vector).

Note: It is assumed that operator is executed for symmetric problem. That means that is executed for not repeating entities on finite element. For example on triangle we have nodes, 3 edges and one face. Because of symmetry calculations are for: nodes-nodes, nodes-edge0, nodes-edge_1, nodes-edge_2, nodes-face, edges_1-edges_1, edges_1-edge_1, edge_1-edge_2, edge_1-edge_1, edge_1-edge_2, edge_2-edge_2, edge_1-face, edge_1-face, edges_3-face, face - face

In case of non symmetric problem in addition calculations of lower off diagonal terms. F.e. edge_1-edge_0, esges_3-edge_0, edge_3-edge_1,

In that case class variable UserDataOperator::sYmm = false;

NoteL: By default sYmm is set for symmetric problems

Examples:

hello_world.cpp, and mesh_smoothing.cpp.

Definition at line 369 of file ForcesAndSourcesCore.hpp.

Member Enumeration Documentation

OpType

enum MoFEM::ForcesAndSourcesCore::UserDataOperator::OpType

Controls loop over entities on element.

OPROW is used if row vector is assembled OPCOL is usually used if column vector is assembled OPROWCOL is usually used for assemble matrices.

For typical problem like Bubnov-Galerkin OPROW and OPCOL are the same. In more general case for example for non-square matrices columns and rows could have different numeration and/or different set of fields.

Enumerator
OPROW
OPCOL
OPROWCOL
OPLAST

Definition at line 383 of file ForcesAndSourcesCore.hpp.

                {
      OPROW = 1 << 0,
      OPCOL = 1 << 1,
      OPROWCOL = 1 << 2,
      OPLAST = 1 << 3
    };

Constructor & Destructor Documentation

UserDataOperator() [1/3]

MoFEM::ForcesAndSourcesCore::UserDataOperator::UserDataOperator	(	const FieldSpace	space,
		const char	type = OPLAST,
		const bool	symm = true
	)

This Constructor is used typically when some modification base shape functions on some approx. space is applied. Operator is run for all data on space.

User has no access to field data from this operator.

Definition at line 402 of file ForcesAndSourcesCore.hpp.

        : DataOperator(symm), opType(type), sPace(space), ptrFE(NULL) {}

UserDataOperator() [2/3]

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

Definition at line 406 of file ForcesAndSourcesCore.hpp.

        : DataOperator(symm), opType(type), rowFieldName(field_name),
          colFieldName(field_name), sPace(LASTSPACE), ptrFE(NULL) {}

UserDataOperator() [3/3]

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

Definition at line 411 of file ForcesAndSourcesCore.hpp.

        : DataOperator(symm), opType(type), rowFieldName(row_field_name),
          colFieldName(col_field_name), sPace(LASTSPACE), ptrFE(NULL) {}

~UserDataOperator()

virtual MoFEM::ForcesAndSourcesCore::UserDataOperator::~UserDataOperator ( )

virtual

Definition at line 417 of file ForcesAndSourcesCore.hpp.

{}

Member Function Documentation

addOpType()

void MoFEM::ForcesAndSourcesCore::UserDataOperator::addOpType

(

const OpType

type

)

Add operator type.

Definition at line 507 of file ForcesAndSourcesCore.hpp.

{ opType |= type; }

getFEEntityHandle()

EntityHandle MoFEM::ForcesAndSourcesCore::UserDataOperator::getFEEntityHandle

(

)

const

Return finite element entity handle.

Returns

Finite element entity handle

Examples:

UnsaturatedFlow.hpp.

Definition at line 430 of file ForcesAndSourcesCore.hpp.

                                                  {
      return getNumeredEntFiniteElementPtr()->getEnt();
    }

getFEMethod()

const FEMethod* MoFEM::ForcesAndSourcesCore::UserDataOperator::getFEMethod

(

)

const

Return raw pointer to Finite Element Method object.

Examples:

analytical_poisson_field_split.cpp, and UnsaturatedFlow.hpp.

Definition at line 490 of file ForcesAndSourcesCore.hpp.

{ return ptrFE; }

getFEName()

const std::string& MoFEM::ForcesAndSourcesCore::UserDataOperator::getFEName

(

)

const

Get name of the element.

Definition at line 523 of file ForcesAndSourcesCore.hpp.

                                              {
      return getFEMethod()->feName;
    }

getFTensor0IntegrationWeight()

auto MoFEM::ForcesAndSourcesCore::UserDataOperator::getFTensor0IntegrationWeight

(

)

Get integration weights.

auto t_w = getFTensor0IntegrationWeight();
for(int gg = 0; gg!=getGaussPts.size2(); ++gg) {
 // integrate something
 ++t_w;
}

Returns

FTensor::Tensor0<FTensor::PackPtr<double *, 1>>

Examples:

analytical_poisson_field_split.cpp, HookeElement.cpp, HookeElement.hpp, and UnsaturatedFlow.hpp.

Definition at line 595 of file ForcesAndSourcesCore.hpp.

                                               {
      return FTensor::Tensor0<FTensor::PackPtr<double *, 1>>(
          &(getGaussPts()(getGaussPts().size1() - 1, 0)));
    }

getGaussPts()

MatrixDouble& MoFEM::ForcesAndSourcesCore::UserDataOperator::getGaussPts

(

)

matrix of integration (Gauss) points for Volume Element

For triangle: columns 0,1 are x,y coordinates respectively and column 2 is a weight value for example getGaussPts()(1,13) returns y coordinate of 13th Gauss point on particular volume element

For tetrahedron: columns 0,1,2 are x,y,z coordinates respectively and column 3 is a weight value for example getGaussPts()(1,13) returns y coordinate of 13th Gauss point on particular volume element

Examples:

analytical_poisson_field_split.cpp, HookeElement.cpp, HookeElement.hpp, MagneticElement.hpp, and UnsaturatedFlow.hpp.

Definition at line 578 of file ForcesAndSourcesCore.hpp.

                                       {
      return static_cast<ForcesAndSourcesCore *>(ptrFE)->gaussPts;
    }

getLoopSize()

int MoFEM::ForcesAndSourcesCore::UserDataOperator::getLoopSize

(

)

const

get size of elements in the loop

Returns

loop size

Definition at line 519 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->getLoopSize(); }

getNinTheLoop()

int MoFEM::ForcesAndSourcesCore::UserDataOperator::getNinTheLoop

(

)

const

get number of finite element in the loop

Returns

number of finite element

Definition at line 513 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->getNinTheLoop(); }

getNumeredEntFiniteElementPtr()

boost::shared_ptr<const NumeredEntFiniteElement> MoFEM::ForcesAndSourcesCore::UserDataOperator::getNumeredEntFiniteElementPtr

(

)

const

Return raw pointer to NumeredEntFiniteElement.

Examples:

HookeElement.hpp, and UnsaturatedFlow.hpp.

Definition at line 422 of file ForcesAndSourcesCore.hpp.

                                          {
      return ptrFE->numeredEntFiniteElementPtr;
    };

getOpType()

int MoFEM::ForcesAndSourcesCore::UserDataOperator::getOpType

(

)

const

Get operator types.

Returns

Return operator type

Definition at line 496 of file ForcesAndSourcesCore.hpp.

{ return opType; }

getPorblemColIndices()

DEPRECATED MoFEMErrorCode MoFEM::ForcesAndSourcesCore::UserDataOperator::getPorblemColIndices	(	const std::string	filed_name,
		const EntityType	type,
		const int	side,
		VectorInt &	indices
	)		const

Definition at line 483 of file ForcesAndSourcesCore.hpp.

                                                                   {
      return getProblemColIndices(filed_name, type, side, indices);
    }

getPorblemRowIndices()

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

Definition at line 453 of file ForcesAndSourcesCore.hpp.

                                                                   {
      return getProblemRowIndices(filed_name, type, side, indices);
    }

getProblemColIndices()

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

Get col indices.

Field could be or not declared for this element but is declared for problem

Parameters

field_name
type	entity type
side	side number, any number if type is MBVERTEX

Returns

indices

NOTE: Using those indices to assemble matrix will result in error if new non-zero values need to be created.

Definition at line 1156 of file ForcesAndSourcesCore.cpp.

                              {
  MoFEMFunctionBegin;
  if (ptrFE == NULL) {
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "data inconsistency");
  }
  CHKERR get_porblem_col_indices(ptrFE, type, side, field_name, indices);
  MoFEMFunctionReturn(0);
}

getProblemRowIndices()

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

Get row indices.

Field could be or not declared for this element but is declared for problem

Parameters

field_name
type	entity type
side	side number, any number if type is MBVERTEX

Returns

indices

NOTE: Using those indices to assemble matrix will result in error if new non-zero values need to be created.

Definition at line 1145 of file ForcesAndSourcesCore.cpp.

                              {
  MoFEMFunctionBegin;
  if (ptrFE == NULL) {
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "data inconsistency");
  }
  CHKERR get_porblem_row_indices(ptrFE, type, side, field_name, indices);
  MoFEMFunctionReturn(0);
}

getSnesA()

Mat MoFEM::ForcesAndSourcesCore::UserDataOperator::getSnesA

(

)

const

Definition at line 535 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->snes_A; }

getSnesB()

Mat MoFEM::ForcesAndSourcesCore::UserDataOperator::getSnesB

(

)

const

Definition at line 537 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->snes_B; }

getSnesF()

Vec MoFEM::ForcesAndSourcesCore::UserDataOperator::getSnesF

(

)

const

Definition at line 531 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->snes_f; }

getSnesX()

Vec MoFEM::ForcesAndSourcesCore::UserDataOperator::getSnesX

(

)

const

Definition at line 533 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->snes_x; }

getTSA()

Mat MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSA

(

)

const

Definition at line 551 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_A; }

getTSa()

double MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSa

(

)

const

Definition at line 559 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_a; }

getTSB()

Mat MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSB

(

)

const

Definition at line 553 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_B; }

getTSf()

Vec MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSf

(

)

const

Definition at line 549 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_F; }

getTSstep()

int MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSstep

(

)

const

Definition at line 555 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_step; }

getTStime()

double MoFEM::ForcesAndSourcesCore::UserDataOperator::getTStime

(

)

const

Definition at line 557 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_t; }

getTSu()

Vec MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSu

(

)

const

Definition at line 545 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_u; }

getTSu_t()

Vec MoFEM::ForcesAndSourcesCore::UserDataOperator::getTSu_t

(

)

const

Definition at line 547 of file ForcesAndSourcesCore.hpp.

{ return getFEMethod()->ts_u_t; }

setOpType()

void MoFEM::ForcesAndSourcesCore::UserDataOperator::setOpType

(

const OpType

type

)

Set operator type.

Parameters

Operator

type

Definition at line 502 of file ForcesAndSourcesCore.hpp.

{ opType = type; }

setPtrFE()

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

virtual

Definition at line 475 of file ForcesAndSourcesCore.hpp.

                                                               {
      MoFEMFunctionBeginHot;
      ptrFE = ptr;
      MoFEMFunctionReturnHot(0);
    }

Member Data Documentation

colFieldName

std::string MoFEM::ForcesAndSourcesCore::UserDataOperator::colFieldName

Definition at line 392 of file ForcesAndSourcesCore.hpp.

opType

char MoFEM::ForcesAndSourcesCore::UserDataOperator::opType

Definition at line 390 of file ForcesAndSourcesCore.hpp.

ptrFE

ForcesAndSourcesCore* MoFEM::ForcesAndSourcesCore::UserDataOperator::ptrFE

protected

Definition at line 603 of file ForcesAndSourcesCore.hpp.

rowFieldName

std::string MoFEM::ForcesAndSourcesCore::UserDataOperator::rowFieldName

Definition at line 391 of file ForcesAndSourcesCore.hpp.

sPace

FieldSpace MoFEM::ForcesAndSourcesCore::UserDataOperator::sPace

Definition at line 393 of file ForcesAndSourcesCore.hpp.

---

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

• src/finite_elements/ForcesAndSourcesCore.hpp
• src/finite_elements/impl/ForcesAndSourcesCore.cpp