MoFEM::ForcesAndSourcesCore::UserDataOperator Struct Reference

#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 , OPSPACE = 1 << 3 ,   OPLAST = 1 << 3 }
	Controls loop over entities on element. More...
Public Types inherited from MoFEM::DataOperator
using	DoWorkLhsHookFunType = boost::function< MoFEMErrorCode(DataOperator *op_ptr, int row_side, int col_side, EntityType row_type, EntityType col_type, EntitiesFieldData::EntData &row_data, EntitiesFieldData::EntData &col_data)>
using	DoWorkRhsHookFunType = boost::function< MoFEMErrorCode(DataOperator *op_ptr, int side, EntityType type, EntitiesFieldData::EntData &data)>

Public Member Functions
	UserDataOperator (const FieldSpace space, const char type=OPSPACE, 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...
int	getFEDim () const
	Get dimension of finite element. More...
EntityType	getFEType () const
	Get dimension of finite element. 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 () const
	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...
std::string	getFEName () const
	Get name of the element. More...
ForcesAndSourcesCore *	getPtrFE () const
ForcesAndSourcesCore *	getSidePtrFE () const
ForcesAndSourcesCore *	getRefinePtrFE () const
Accessing KSP
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
Accessing SNES
Vec	getSNESf () const
Vec	getSNESx () const
Mat	getSNESA () const
Mat	getSNESB () const
Accessing TS
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	getTStimeStep () const
double	getTSa () const
double	getTSaa () const
Base funtions and integration points
MatrixDouble &	getGaussPts ()
	matrix of integration (Gauss) points for Volume Element More...
auto	getFTensor0IntegrationWeight ()
	Get integration weights. More...
Coordinates and access to internal data
MatrixDouble &	getCoordsAtGaussPts ()
	Gauss points and weight, matrix (nb. of points x 3) More...
auto	getFTensor1CoordsAtGaussPts ()
	Get coordinates at integration points assuming linear geometry. More...
Measures (area, volume, length, etc.)
double	getMeasure () const
	get measure of element More...
double &	getMeasure ()
	get measure of element More...
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, EntitiesFieldData::EntData &row_data, EntitiesFieldData::EntData &col_data)
	Operator for bi-linear form, usually to calculate values on left hand side. More...
virtual MoFEMErrorCode	opLhs (EntitiesFieldData &row_data, EntitiesFieldData &col_data)
virtual MoFEMErrorCode	doWork (int side, EntityType type, EntitiesFieldData::EntData &data)
	Operator for linear form, usually to calculate values on right hand side. More...
virtual MoFEMErrorCode	opRhs (EntitiesFieldData &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...

Public Attributes
char	opType
std::string	rowFieldName
std::string	colFieldName
FieldSpace	sPace
Public Attributes inherited from MoFEM::DataOperator
DoWorkLhsHookFunType	doWorkLhsHook
DoWorkRhsHookFunType	doWorkRhsHook
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...

Static Public Attributes
static const char *const	OpTypeNames []

Protected Member Functions
virtual MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)

Protected Attributes
ForcesAndSourcesCore *	ptrFE

Friends
class	ForcesAndSourcesCore
class	EdgeElementForcesAndSourcesCore
class	FaceElementForcesAndSourcesCore
class	ContactPrismElementForcesAndSourcesCore

Loops
}
using	AdjCache = std::map< EntityHandle, std::vector< boost::weak_ptr< NumeredEntFiniteElement > > >
MoFEMErrorCode	loopSide (const string &fe_name, ForcesAndSourcesCore *side_fe, const size_t dim, const EntityHandle ent_for_side=0, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy, AdjCache *adj_cache=nullptr)
	User call this function to loop over elements on the side of face. This function calls finite element with is operator to do calculations. More...
MoFEMErrorCode	loopThis (const string &fe_name, ForcesAndSourcesCore *parent_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User call this function to loop over parent elements. This function calls finite element with is operator to do calculations. More...
MoFEMErrorCode	loopParent (const string &fe_name, ForcesAndSourcesCore *parent_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User call this function to loop over parent elements. This function calls finite element with is operator to do calculations. More...
MoFEMErrorCode	loopChildren (const string &fe_name, ForcesAndSourcesCore *child_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User call this function to loop over parent elements. This function calls finite element with is operator to do calculations. More...

Detailed Description

Examples

dynamic_first_order_con_law.cpp, free_surface.cpp, hanging_node_approx.cpp, hello_world.cpp, level_set.cpp, mesh_smoothing.cpp, and plastic.cpp.

Definition at line 546 of file ForcesAndSourcesCore.hpp.

Member Typedef Documentation

AdjCache

using MoFEM::ForcesAndSourcesCore::UserDataOperator::AdjCache = std::map<EntityHandle, std::vector<boost::weak_ptr<NumeredEntFiniteElement> >>

Definition at line 899 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.
• OPSPACE no field is defined for such operator. Is usually used to modify base

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	operator doWork function is executed on FE rows
OPCOL	operator doWork function is executed on FE columns
OPROWCOL	operator doWork is executed on FE rows &columns
OPSPACE	operator do Work is execute on space data
OPLAST	Deprecated: would be removed

Definition at line 563 of file ForcesAndSourcesCore.hpp.

              {
    OPROW = 1 << 0,    ///< operator doWork function is executed on FE rows
    OPCOL = 1 << 1,    ///< operator doWork function is executed on FE columns
    OPROWCOL = 1 << 2, ///< operator doWork is executed on FE rows &columns
    OPSPACE = 1 << 3,  ///< operator do Work is execute on space data
    OPLAST = 1 << 3    ///< @deprecated would be removed
  };

Constructor & Destructor Documentation

UserDataOperator() [1/3]

ForcesAndSourcesCore::UserDataOperator::UserDataOperator	(	const FieldSpace	space,
		const char	type = OPSPACE,
		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 1942 of file ForcesAndSourcesCore.cpp.

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

UserDataOperator() [2/3]

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

Definition at line 1947 of file ForcesAndSourcesCore.cpp.

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

UserDataOperator() [3/3]

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 1952 of file ForcesAndSourcesCore.cpp.

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

Member Function Documentation

addOpType()

void ForcesAndSourcesCore::UserDataOperator::addOpType ( const OpType  type )

inline

Add operator type.

Definition at line 1047 of file ForcesAndSourcesCore.hpp.

                                                                      {
  opType |= type;
}

getCoordsAtGaussPts()

MatrixDouble & ForcesAndSourcesCore::UserDataOperator::getCoordsAtGaussPts ( )

inline

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

MagneticElement.hpp, UnsaturatedFlow.hpp, continuity_check_on_skeleton_with_simple_2d_for_h1.cpp, continuity_check_on_skeleton_with_simple_2d_for_hcurl.cpp, continuity_check_on_skeleton_with_simple_2d_for_hdiv.cpp, forces_and_sources_testing_edge_element.cpp, forces_and_sources_testing_flat_prism_element.cpp, hcurl_check_approx_in_2d.cpp, and scalar_check_approximation.cpp.

Definition at line 1260 of file ForcesAndSourcesCore.hpp.

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

getDataCtx()

const PetscData::Switches & ForcesAndSourcesCore::UserDataOperator::getDataCtx ( ) const

inline

Definition at line 1064 of file ForcesAndSourcesCore.hpp.

                                                       {
  return getFEMethod()->data_ctx;
}

getFEDim()

int ForcesAndSourcesCore::UserDataOperator::getFEDim ( ) const

inline

Get dimension of finite element.

Returns

int

Definition at line 1003 of file ForcesAndSourcesCore.hpp.

                                                         {
  return dimension_from_handle(getFEEntityHandle());
};

getFEEntityHandle()

EntityHandle ForcesAndSourcesCore::UserDataOperator::getFEEntityHandle ( ) const

inline

Return finite element entity handle.

Returns

Finite element entity handle

Examples

HookeInternalStressElement.hpp, UnsaturatedFlow.hpp, and mixed_poisson.cpp.

Definition at line 999 of file ForcesAndSourcesCore.hpp.

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

getFEMethod()

const FEMethod * ForcesAndSourcesCore::UserDataOperator::getFEMethod ( ) const

inline

Return raw pointer to Finite Element Method object.

Examples

UnsaturatedFlow.hpp, continuity_check_on_skeleton_with_simple_2d_for_h1.cpp, continuity_check_on_skeleton_with_simple_2d_for_hcurl.cpp, continuity_check_on_skeleton_with_simple_2d_for_hdiv.cpp, reaction_diffusion.cpp, and simple_elasticity.cpp.

Definition at line 1037 of file ForcesAndSourcesCore.hpp.

                                                                        {
  return ptrFE;
}

getFEName()

std::string ForcesAndSourcesCore::UserDataOperator::getFEName ( ) const

inline

Get name of the element.

Definition at line 1059 of file ForcesAndSourcesCore.hpp.

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

getFEType()

EntityType ForcesAndSourcesCore::UserDataOperator::getFEType ( ) const

inline

Get dimension of finite element.

Returns

int

Definition at line 1007 of file ForcesAndSourcesCore.hpp.

                                                                 {
  return type_from_handle(getFEEntityHandle());
};

getFTensor0IntegrationWeight()

auto ForcesAndSourcesCore::UserDataOperator::getFTensor0IntegrationWeight ( )

inline

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

ContactOps.hpp, PlasticOpsGeneric.hpp, PoissonDiscontinousGalerkin.hpp, UnsaturatedFlow.hpp, approx_sphere.cpp, child_and_parent.cpp, hanging_node_approx.cpp, hcurl_divergence_operator_2d.cpp, higher_derivatives.cpp, mixed_poisson.cpp, phase.cpp, photon_diffusion.cpp, plate.cpp, prism_polynomial_approximation.cpp, quad_polynomial_approximation.cpp, reaction_diffusion.cpp, simple_elasticity.cpp, and simple_interface.cpp.

Definition at line 1235 of file ForcesAndSourcesCore.hpp.

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

getFTensor1CoordsAtGaussPts()

auto ForcesAndSourcesCore::UserDataOperator::getFTensor1CoordsAtGaussPts ( )

inline

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

ContactOps.hpp, PoissonDiscontinousGalerkin.hpp, UnsaturatedFlow.hpp, child_and_parent.cpp, hanging_node_approx.cpp, higher_derivatives.cpp, mixed_poisson.cpp, prism_polynomial_approximation.cpp, quad_polynomial_approximation.cpp, and simple_interface.cpp.

Definition at line 1264 of file ForcesAndSourcesCore.hpp.

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

getGaussPts()

MatrixDouble & ForcesAndSourcesCore::UserDataOperator::getGaussPts ( )

inline

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

ContactOps.hpp, MagneticElement.hpp, PlasticOpsGeneric.hpp, PoissonDiscontinousGalerkin.hpp, ThermoElasticOps.hpp, UnsaturatedFlow.hpp, approx_sphere.cpp, child_and_parent.cpp, continuity_check_on_skeleton_3d.cpp, free_surface.cpp, hanging_node_approx.cpp, higher_derivatives.cpp, level_set.cpp, mixed_poisson.cpp, phase.cpp, photon_diffusion.cpp, plate.cpp, reaction_diffusion.cpp, scalar_check_approximation.cpp, and simple_interface.cpp.

Definition at line 1231 of file ForcesAndSourcesCore.hpp.

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

getKSPA()

Mat ForcesAndSourcesCore::UserDataOperator::getKSPA ( ) const

inline

Examples

plastic.cpp.

Definition at line 1091 of file ForcesAndSourcesCore.hpp.

                                                        {
#ifndef NDEBUG
  if (getFEMethod()->ksp_A == PETSC_NULL)
    THROW_MESSAGE("KSP not set A vector");
#endif
  return getFEMethod()->ksp_A;
}

getKSPB()

Mat ForcesAndSourcesCore::UserDataOperator::getKSPB ( ) const

inline

Examples

PoissonDiscontinousGalerkin.hpp, plastic.cpp, and plate.cpp.

Definition at line 1099 of file ForcesAndSourcesCore.hpp.

                                                        {
#ifndef NDEBUG
  if (getFEMethod()->ksp_B == PETSC_NULL)
    THROW_MESSAGE("KSP not set B vector");
#endif
  return getFEMethod()->ksp_B;
}

getKSPCtx()

const KspMethod::KSPContext ForcesAndSourcesCore::UserDataOperator::getKSPCtx ( ) const

inline

Definition at line 1069 of file ForcesAndSourcesCore.hpp.

                                                      {
  return getFEMethod()->ksp_ctx;
}

getKSPf()

Vec ForcesAndSourcesCore::UserDataOperator::getKSPf ( ) const

inline

Examples

PoissonDiscontinousGalerkin.hpp.

Definition at line 1083 of file ForcesAndSourcesCore.hpp.

                                                        {
#ifndef NDEBUG
  if (getFEMethod()->ksp_f == PETSC_NULL)
    THROW_MESSAGE("KSP not set F vector");
#endif
  return getFEMethod()->ksp_f;
}

getLoopSize()

int ForcesAndSourcesCore::UserDataOperator::getLoopSize ( ) const

inline

get size of elements in the loop

Returns

loop size

Definition at line 1055 of file ForcesAndSourcesCore.hpp.

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

getMeasure() [1/2]

double & ForcesAndSourcesCore::UserDataOperator::getMeasure ( )

inline

get measure of element

Returns

volume

Definition at line 1274 of file ForcesAndSourcesCore.hpp.

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

getMeasure() [2/2]

double ForcesAndSourcesCore::UserDataOperator::getMeasure ( ) const

inline

get measure of element

Returns

volume

Examples

ContactOps.hpp, PoissonDiscontinousGalerkin.hpp, child_and_parent.cpp, hanging_node_approx.cpp, hcurl_divergence_operator_2d.cpp, higher_derivatives.cpp, mixed_poisson.cpp, photon_diffusion.cpp, plate.cpp, quad_polynomial_approximation.cpp, and reaction_diffusion.cpp.

Definition at line 1270 of file ForcesAndSourcesCore.hpp.

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

getNinTheLoop()

int ForcesAndSourcesCore::UserDataOperator::getNinTheLoop ( ) const

inline

get number of finite element in the loop

Returns

number of finite element

Definition at line 1051 of file ForcesAndSourcesCore.hpp.

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

getNumberOfNodesOnElement()

int ForcesAndSourcesCore::UserDataOperator::getNumberOfNodesOnElement ( ) const

inline

Get the number of nodes on finite element.

Returns

int

Examples

boundary_marker.cpp.

Definition at line 1033 of file ForcesAndSourcesCore.hpp.

                                                                          {
  return ptrFE->getNumberOfNodes();
}

getNumeredEntFiniteElementPtr()

boost::shared_ptr< const NumeredEntFiniteElement > ForcesAndSourcesCore::UserDataOperator::getNumeredEntFiniteElementPtr ( ) const

inline

Return raw pointer to NumeredEntFiniteElement.

Examples

ElasticityMixedFormulation.hpp, NavierStokesElement.cpp, and UnsaturatedFlow.hpp.

Definition at line 995 of file ForcesAndSourcesCore.hpp.

                                                                          {
  return ptrFE->numeredEntFiniteElementPtr;
};

getOpType()

int ForcesAndSourcesCore::UserDataOperator::getOpType ( ) const

inline

Get operator types.

Returns

Return operator type

Definition at line 1041 of file ForcesAndSourcesCore.hpp.

{ return opType; }

getProblemColIndices()

MoFEMErrorCode ForcesAndSourcesCore::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 1637 of file ForcesAndSourcesCore.cpp.

                              {
  MoFEMFunctionBegin;
  if (ptrFE == NULL)
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "data inconsistency");
 
  switch (type) {
  case MBVERTEX:
    CHKERR ptrFE->getProblemNodesColIndices(field_name, indices);
    break;
  default:
    CHKERR ptrFE->getProblemTypeColIndices(field_name, type, side, indices);
  }
  MoFEMFunctionReturn(0);
}

getProblemRowIndices()

MoFEMErrorCode ForcesAndSourcesCore::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 1620 of file ForcesAndSourcesCore.cpp.

                              {
  MoFEMFunctionBegin;
  if (ptrFE == NULL)
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "data inconsistency");
 
  switch (type) {
  case MBVERTEX:
    CHKERR ptrFE->getProblemNodesRowIndices(field_name, indices);
    break;
  default:
    CHKERR ptrFE->getProblemTypeRowIndices(field_name, type, side, indices);
  }
  MoFEMFunctionReturn(0);
}

getPtrFE()

ForcesAndSourcesCore * ForcesAndSourcesCore::UserDataOperator::getPtrFE ( ) const

inline

Definition at line 1246 of file ForcesAndSourcesCore.hpp.

                                                                           {
  return ptrFE;
}

getRefinePtrFE()

ForcesAndSourcesCore * ForcesAndSourcesCore::UserDataOperator::getRefinePtrFE ( ) const

inline

Definition at line 1256 of file ForcesAndSourcesCore.hpp.

                                                           {
  return ptrFE->refinePtrFE;
}

getSideEntity()

EntityHandle ForcesAndSourcesCore::UserDataOperator::getSideEntity ( const int  side_number, const EntityType  type  )

inline

Get the side entity.

Note

For vertex is expectation. Side basses in argument of function doWork is zero. For other entity types side can be used as argument of this function.

MoFEMErrorCode doWork(int side, EntityType type,
                    EntitiesFieldData::EntData &data) {
 MoFEMFunctionBegin;
 
 if (type == MBVERTEX) {
   for (int n = 0; n != number_of_nodes; ++n)
     EntityHandle ent = getSideEntity(n, type);
 
     // Do somthing
 
 } else {
   EntityHandle ent = getSideEntity(side, type);
 
   // Do somthing
 
 }
 
 MoFEMFunctionReturn(0);
}

Parameters

side_number
type

Examples

boundary_marker.cpp.

Definition at line 1025 of file ForcesAndSourcesCore.hpp.

                                                                             {
  if (auto side_ptr = getSideNumberPtr(side_number, type).lock())
    return side_ptr->ent;
  else
    return 0;
}

getSideNumberPtr()

boost::weak_ptr< SideNumber > ForcesAndSourcesCore::UserDataOperator::getSideNumberPtr ( const int  side_number, const EntityType  type  )

inline

Get the side number pointer.

Note

For vertex is expectation. Side basses in argument of function doWork is zero. For other entity types side can be used as argument of this function.

Parameters

side_number
type

Returns

boost::weak_ptr<SideNumber>

Definition at line 1012 of file ForcesAndSourcesCore.hpp.

                                                  {
  auto &side_table_by_side_and_type =
      ptrFE->numeredEntFiniteElementPtr->getSideNumberTable().get<1>();
  auto side_it =
      side_table_by_side_and_type.find(boost::make_tuple(type, side_number));
  if (side_it != side_table_by_side_and_type.end())
    return *side_it;
  else
    return boost::weak_ptr<SideNumber>();
}

getSidePtrFE()

ForcesAndSourcesCore * ForcesAndSourcesCore::UserDataOperator::getSidePtrFE ( ) const

inline

Definition at line 1251 of file ForcesAndSourcesCore.hpp.

                                                         {
  return ptrFE->sidePtrFE;
}

getSNESA()

Mat ForcesAndSourcesCore::UserDataOperator::getSNESA ( ) const

inline

Definition at line 1123 of file ForcesAndSourcesCore.hpp.

                                                         {
#ifndef NDEBUG
  if (getFEMethod()->snes_A == PETSC_NULL)
    THROW_MESSAGE("SNES not set A vector");
#endif
  return getFEMethod()->snes_A;
}

getSNESB()

Mat ForcesAndSourcesCore::UserDataOperator::getSNESB ( ) const

inline

Definition at line 1131 of file ForcesAndSourcesCore.hpp.

                                                         {
#ifndef NDEBUG
  if (getFEMethod()->snes_B == PETSC_NULL)
    THROW_MESSAGE("SNES not set A matrix");
#endif
  return getFEMethod()->snes_B;
}

getSNESCtx()

const SnesMethod::SNESContext ForcesAndSourcesCore::UserDataOperator::getSNESCtx ( ) const

inline

Definition at line 1074 of file ForcesAndSourcesCore.hpp.

                                                       {
  return getFEMethod()->snes_ctx;
}

getSNESf()

Vec ForcesAndSourcesCore::UserDataOperator::getSNESf ( ) const

inline

Definition at line 1107 of file ForcesAndSourcesCore.hpp.

                                                         {
#ifndef NDEBUG
  if (getFEMethod()->snes_f == PETSC_NULL)
    THROW_MESSAGE("SNES not set F vector");
#endif
  return getFEMethod()->snes_f;
}

getSNESx()

Vec ForcesAndSourcesCore::UserDataOperator::getSNESx ( ) const

inline

Definition at line 1115 of file ForcesAndSourcesCore.hpp.

                                                         {
#ifndef NDEBUG
  if (getFEMethod()->snes_x == PETSC_NULL)
    THROW_MESSAGE("SNESnot set X vector");
#endif
  return getFEMethod()->snes_x;
}

getTSA()

Mat ForcesAndSourcesCore::UserDataOperator::getTSA ( ) const

inline

Definition at line 1171 of file ForcesAndSourcesCore.hpp.

                                                       {
#ifndef NDEBUG
  if (getFEMethod()->ts_A == PETSC_NULL)
    THROW_MESSAGE("TS not set A matrix");
#endif
  return getFEMethod()->ts_A;
}

getTSa()

double ForcesAndSourcesCore::UserDataOperator::getTSa ( ) const

inline

Definition at line 1211 of file ForcesAndSourcesCore.hpp.

                                                          {
#ifndef NDEBUG
  if ((getFEMethod()->data_ctx & (PetscData::CtxSetA | PetscData::CtxSetB))
          .none() ||
      (getFEMethod()->data_ctx & (PetscData::CtxSetX_T)).none())
    THROW_MESSAGE("TS not set B matrix");
#endif
  return getFEMethod()->ts_a;
}

getTSaa()

double ForcesAndSourcesCore::UserDataOperator::getTSaa ( ) const

inline

Definition at line 1221 of file ForcesAndSourcesCore.hpp.

                                                           {
#ifndef NDEBUG
  if ((getFEMethod()->data_ctx & (PetscData::CtxSetA | PetscData::CtxSetB))
          .none() ||
      (getFEMethod()->data_ctx & (PetscData::CtxSetX_TT)).none())
    THROW_MESSAGE("TS not set B matrix");
#endif
  return getFEMethod()->ts_aa;
}

getTSB()

Mat ForcesAndSourcesCore::UserDataOperator::getTSB ( ) const

inline

Definition at line 1179 of file ForcesAndSourcesCore.hpp.

                                                       {
#ifndef NDEBUG
  if (getFEMethod()->ts_B == PETSC_NULL)
    THROW_MESSAGE("TS not set B matrix");
#endif
  return getFEMethod()->ts_B;
}

getTSCtx()

const TSMethod::TSContext ForcesAndSourcesCore::UserDataOperator::getTSCtx ( ) const

inline

Examples

PlasticOpsGeneric.hpp.

Definition at line 1079 of file ForcesAndSourcesCore.hpp.

                                                     {
  return getFEMethod()->ts_ctx;
}

getTSf()

Vec ForcesAndSourcesCore::UserDataOperator::getTSf ( ) const

inline

Definition at line 1163 of file ForcesAndSourcesCore.hpp.

                                                       {
#ifndef NDEBUG
  if (getFEMethod()->ts_F == PETSC_NULL)
    THROW_MESSAGE("TS not set F vector");
#endif
  return getFEMethod()->ts_F;
}

getTSstep()

int ForcesAndSourcesCore::UserDataOperator::getTSstep ( ) const

inline

Definition at line 1187 of file ForcesAndSourcesCore.hpp.

                                                          {
#ifndef NDEBUG
  if ((getFEMethod()->data_ctx & PetscData::PetscData::CtxSetTime).none())
    THROW_MESSAGE("TS not set time");
#endif
  return getFEMethod()->ts_step;
}

getTStime()

double ForcesAndSourcesCore::UserDataOperator::getTStime ( ) const

inline

Examples

ContactOps.hpp.

Definition at line 1195 of file ForcesAndSourcesCore.hpp.

                                                             {
#ifndef NDEBUG
  if ((getFEMethod()->data_ctx & PetscData::PetscData::CtxSetTime).none())
    THROW_MESSAGE("TS not set time");
#endif
  return getFEMethod()->ts_t;
}

getTStimeStep()

double ForcesAndSourcesCore::UserDataOperator::getTStimeStep ( ) const

inline

Definition at line 1203 of file ForcesAndSourcesCore.hpp.

                                                                 {
#ifndef NDEBUG
  if ((getFEMethod()->data_ctx & PetscData::PetscData::CtxSetTime).none())
    THROW_MESSAGE("TS not set time");
#endif
  return getFEMethod()->ts_dt;
}

getTSu()

Vec ForcesAndSourcesCore::UserDataOperator::getTSu ( ) const

inline

Definition at line 1139 of file ForcesAndSourcesCore.hpp.

                                                       {
#ifndef NDEBUG
  if (getFEMethod()->ts_u == PETSC_NULL)
    THROW_MESSAGE("TS not set U vector");
#endif
  return getFEMethod()->ts_u;
}

getTSu_t()

Vec ForcesAndSourcesCore::UserDataOperator::getTSu_t ( ) const

inline

Definition at line 1147 of file ForcesAndSourcesCore.hpp.

                                                         {
#ifndef NDEBUG
  if (getFEMethod()->ts_u_t == PETSC_NULL)
    THROW_MESSAGE("TS not set U_t vector");
#endif
  return getFEMethod()->ts_u_t;
}

getTSu_tt()

Vec ForcesAndSourcesCore::UserDataOperator::getTSu_tt ( ) const

inline

Definition at line 1155 of file ForcesAndSourcesCore.hpp.

                                                          {
#ifndef NDEBUG
  if (getFEMethod()->ts_u_tt == PETSC_NULL)
    THROW_MESSAGE("TS not set U_tt vector");
#endif
  return getFEMethod()->ts_u_tt;
}

loopChildren()

MoFEMErrorCode ForcesAndSourcesCore::UserDataOperator::loopChildren	(	const string &	fe_name,
		ForcesAndSourcesCore *	child_fe,
		const int	verb = QUIET,
		const LogManager::SeverityLevel	sev = Sev::noisy
	)

User call this function to loop over parent elements. This function calls finite element with is operator to do calculations.

Parameters

fe_name
child_fe
verb
sev

Returns

MoFEMErrorCode

Definition at line 1839 of file ForcesAndSourcesCore.cpp.

                                       {
  MoFEMFunctionBegin;
 
  auto fe_miit = ptrFE->mField.get_finite_elements()
                     ->get<FiniteElement_name_mi_tag>()
                     .find(fe_name);
  if (fe_miit != ptrFE->mField.get_finite_elements()
                     ->get<FiniteElement_name_mi_tag>()
                     .end()) {
 
    const auto *problem_ptr = getFEMethod()->problemPtr;
    auto &ref_ents = *getPtrFE()->mField.get_ref_ents();
    auto &numered_fe =
        problem_ptr->numeredFiniteElementsPtr->get<Unique_mi_tag>();
 
    const auto parent_ent = getNumeredEntFiniteElementPtr()->getEnt();
    const auto parent_type = getNumeredEntFiniteElementPtr()->getEntType();
    auto range =
        ref_ents.get<Composite_ParentEnt_And_EntType_mi_tag>().equal_range(
            boost::make_tuple(parent_type, parent_ent));
 
    if (auto size = std::distance(range.first, range.second)) {
 
      std::vector<EntityHandle> childs_vec;
      childs_vec.reserve(size);
      for (; range.first != range.second; ++range.first)
        childs_vec.emplace_back((*range.first)->getEnt());
 
      Range childs;
 
      if ((childs_vec.back() - childs_vec.front() + 1) == size)
        childs = Range(childs_vec.front(), childs_vec.back());
      else
        childs.insert_list(childs_vec.begin(), childs_vec.end());
 
      child_fe->feName = fe_name;
 
      CHKERR child_fe->setRefineFEPtr(ptrFE);
      CHKERR child_fe->copyBasicMethod(*getFEMethod());
      CHKERR child_fe->copyPetscData(*getFEMethod());
      CHKERR child_fe->copyKsp(*getFEMethod());
      CHKERR child_fe->copySnes(*getFEMethod());
      CHKERR child_fe->copyTs(*getFEMethod());
 
      child_fe->cacheWeakPtr = getFEMethod()->cacheWeakPtr;
 
      CHKERR child_fe->preProcess();
 
      int nn = 0;
      child_fe->loopSize = size;
 
      for (auto p = childs.pair_begin(); p != childs.pair_end(); ++p) {
 
        auto miit =
            numered_fe.lower_bound(EntFiniteElement::getLocalUniqueIdCalculate(
                p->first, (*fe_miit)->getFEUId()));
        auto hi_miit =
            numered_fe.upper_bound(EntFiniteElement::getLocalUniqueIdCalculate(
                p->second, (*fe_miit)->getFEUId()));
 
        for (; miit != hi_miit; ++miit) {
 
          if (verb >= VERBOSE)
            MOFEM_LOG("SELF", sev) << "Child finite element "
                                   << "(" << nn << "): " << **miit;
 
          child_fe->nInTheLoop = nn++;
          child_fe->numeredEntFiniteElementPtr = *miit;
          CHKERR (*child_fe)();
        }
      }
    }
 
    CHKERR child_fe->postProcess();
  }
 
  MoFEMFunctionReturn(0);
}

loopParent()

MoFEMErrorCode ForcesAndSourcesCore::UserDataOperator::loopParent	(	const string &	fe_name,
		ForcesAndSourcesCore *	parent_fe,
		const int	verb = QUIET,
		const LogManager::SeverityLevel	sev = Sev::noisy
	)

User call this function to loop over parent elements. This function calls finite element with is operator to do calculations.

Parameters

fe_name
parent_fe
verb
sev

Returns

MoFEMErrorCode

Definition at line 1789 of file ForcesAndSourcesCore.cpp.

                                       {
  MoFEMFunctionBegin;
 
  auto &fes =
      ptrFE->mField.get_finite_elements()->get<FiniteElement_name_mi_tag>();
  auto fe_miit = fes.find(fe_name);
  if (fe_miit != fes.end()) {
 
    const auto *problem_ptr = getFEMethod()->problemPtr;
    auto &numered_fe =
        problem_ptr->numeredFiniteElementsPtr->get<Unique_mi_tag>();
 
 
    parent_fe->feName = fe_name;
    CHKERR parent_fe->setRefineFEPtr(ptrFE);
    CHKERR parent_fe->copyBasicMethod(*getFEMethod());
    CHKERR parent_fe->copyPetscData(*getFEMethod());
    CHKERR parent_fe->copyKsp(*getFEMethod());
    CHKERR parent_fe->copySnes(*getFEMethod());
    CHKERR parent_fe->copyTs(*getFEMethod());
 
    parent_fe->cacheWeakPtr = getFEMethod()->cacheWeakPtr;
 
    const auto parent_ent = getNumeredEntFiniteElementPtr()->getParentEnt();
    auto miit = numered_fe.find(EntFiniteElement::getLocalUniqueIdCalculate(
        parent_ent, (*fe_miit)->getFEUId()));
    if (miit != numered_fe.end()) {
      if (verb >= VERBOSE)
        MOFEM_LOG("SELF", sev) << "Parent finite element: " << **miit;
      parent_fe->loopSize = 1;
      parent_fe->nInTheLoop = 0;
      parent_fe->numeredEntFiniteElementPtr = *miit;
      CHKERR parent_fe->preProcess();
      CHKERR (*parent_fe)();
      CHKERR parent_fe->postProcess();
    } else {
      if (verb >= VERBOSE)
        MOFEM_LOG("SELF", sev) << "Parent finite element: no parent";
      parent_fe->loopSize = 0;
      parent_fe->nInTheLoop = 0;
      CHKERR parent_fe->preProcess();
      CHKERR parent_fe->postProcess();
    }
  }
 
  MoFEMFunctionReturn(0);
}

loopSide()

MoFEMErrorCode ForcesAndSourcesCore::UserDataOperator::loopSide	(	const string &	fe_name,
		ForcesAndSourcesCore *	side_fe,
		const size_t	dim,
		const EntityHandle	ent_for_side = 0,
		const int	verb = QUIET,
		const LogManager::SeverityLevel	sev = Sev::noisy,
		AdjCache *	adj_cache = nullptr
	)

User call this function to loop over elements on the side of face. This function calls finite element with is operator to do calculations.

Parameters

fe_name	name of the side element
side_fe	pointer to the side element instance
dim	dimension the of side element
ent_for_side	entity handle for which adjacent volume or face will be accessed
verb
sev

Returns

MoFEMErrorCode

Definition at line 1668 of file ForcesAndSourcesCore.cpp.

                                                            {
  MoFEMFunctionBegin;
 
  const auto *problem_ptr = getFEMethod()->problemPtr;
  auto &numered_fe =
      problem_ptr->numeredFiniteElementsPtr->get<Unique_mi_tag>();
 
  auto fe_miit = ptrFE->mField.get_finite_elements()
                     ->get<FiniteElement_name_mi_tag>()
                     .find(fe_name);
  if (fe_miit != ptrFE->mField.get_finite_elements()
                     ->get<FiniteElement_name_mi_tag>()
                     .end()) {
 
    const auto ent = ent_for_side ? ent_for_side : getFEEntityHandle();
 
    side_fe->feName = fe_name;
 
    CHKERR side_fe->setSideFEPtr(ptrFE);
    CHKERR side_fe->copyBasicMethod(*getFEMethod());
    CHKERR side_fe->copyPetscData(*getFEMethod());
    CHKERR side_fe->copyKsp(*getFEMethod());
    CHKERR side_fe->copySnes(*getFEMethod());
    CHKERR side_fe->copyTs(*getFEMethod());
 
    side_fe->cacheWeakPtr = getFEMethod()->cacheWeakPtr;
 
    CHKERR side_fe->preProcess();
 
    std::vector<boost::weak_ptr<NumeredEntFiniteElement>> fe_vec;
    auto get_numered_fe_ptr = [&](auto &fe_uid, Range &&adjacent_ents)
        -> std::vector<boost::weak_ptr<NumeredEntFiniteElement>> & {
      fe_vec.reserve(adjacent_ents.size());
      for (auto fe_ent : adjacent_ents) {
        auto miit = numered_fe.find(
            EntFiniteElement::getLocalUniqueIdCalculate(fe_ent, fe_uid));
        if (miit != numered_fe.end()) {
          fe_vec.emplace_back(*miit);
        }
      }
      return fe_vec;
    };
 
    auto get_bit_entity_adjacency = [&]() {
      Range adjacent_ents;
      CHKERR ptrFE->mField.getInterface<BitRefManager>()->getAdjacenciesAny(
          ent, side_dim, adjacent_ents);
      return adjacent_ents;
    };
 
    auto get_adj = [&](auto &fe_uid)
        -> std::vector<boost::weak_ptr<NumeredEntFiniteElement>> & {
      if (adj_cache) {
        try {
          return (*adj_cache).at(ent);
        } catch (const std::out_of_range &) {
          return (*adj_cache)[ent] =
                     get_numered_fe_ptr(fe_uid, get_bit_entity_adjacency());
        }
      } else {
        return get_numered_fe_ptr(fe_uid, get_bit_entity_adjacency());
      }
    };
 
    auto adj = get_adj((*fe_miit)->getFEUId());
 
    int nn = 0;
    side_fe->loopSize = adj.size();
    for (auto fe_weak_ptr : adj) {
      if (auto fe_ptr = fe_weak_ptr.lock()) {
        if (verb >= VERBOSE)
          MOFEM_LOG("SELF", sev) << "Side finite element "
                                 << "(" << nn << "): " << *fe_ptr;
        side_fe->nInTheLoop = nn;
        side_fe->numeredEntFiniteElementPtr = fe_ptr;
        CHKERR (*side_fe)();
      }
      ++nn;
    }
 
    CHKERR side_fe->postProcess();
  }
 
  MoFEMFunctionReturn(0);
}

loopThis()

MoFEMErrorCode ForcesAndSourcesCore::UserDataOperator::loopThis	(	const string &	fe_name,
		ForcesAndSourcesCore *	parent_fe,
		const int	verb = QUIET,
		const LogManager::SeverityLevel	sev = Sev::noisy
	)

User call this function to loop over parent elements. This function calls finite element with is operator to do calculations.

Parameters

fe_name
parent_fe
verb
sev

Returns

MoFEMErrorCode

Definition at line 1757 of file ForcesAndSourcesCore.cpp.

                                       {
  MoFEMFunctionBegin;
 
  if (verb >= VERBOSE)
    MOFEM_LOG("SELF", sev) << "This finite element: "
                           << *getNumeredEntFiniteElementPtr();
 
  this_fe->feName = fe_name;
 
  CHKERR this_fe->setRefineFEPtr(ptrFE);
  CHKERR this_fe->copyBasicMethod(*getFEMethod());
  CHKERR this_fe->copyPetscData(*getFEMethod());
  CHKERR this_fe->copyKsp(*getFEMethod());
  CHKERR this_fe->copySnes(*getFEMethod());
  CHKERR this_fe->copyTs(*getFEMethod());
 
  this_fe->cacheWeakPtr = getFEMethod()->cacheWeakPtr;
 
  CHKERR this_fe->preProcess();
 
  this_fe->nInTheLoop = getNinTheLoop();
  this_fe->numeredEntFiniteElementPtr = getNumeredEntFiniteElementPtr();
 
  CHKERR (*this_fe)();
 
  CHKERR this_fe->postProcess();
 
  MoFEMFunctionReturn(0);
}

setOpType()

void ForcesAndSourcesCore::UserDataOperator::setOpType ( const OpType  type )

inline

Set operator type.

Parameters

Operator

type

Definition at line 1043 of file ForcesAndSourcesCore.hpp.

                                                                      {
  opType = type;
}

setPtrFE()

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

protectedvirtual

Reimplemented in MoFEM::EdgeElementForcesAndSourcesCore::UserDataOperator, MoFEM::FaceElementForcesAndSourcesCore::UserDataOperator, MoFEM::FaceElementForcesAndSourcesCoreOnSide::UserDataOperator, MoFEM::FatPrismElementForcesAndSourcesCore::UserDataOperator, MoFEM::FlatPrismElementForcesAndSourcesCore::UserDataOperator, MoFEM::VertexElementForcesAndSourcesCore::UserDataOperator, MoFEM::VolumeElementForcesAndSourcesCore::UserDataOperator, and MoFEM::VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator.

Definition at line 1991 of file ForcesAndSourcesCore.cpp.

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

Friends And Related Function Documentation

ContactPrismElementForcesAndSourcesCore

friend class ContactPrismElementForcesAndSourcesCore

friend

Definition at line 988 of file ForcesAndSourcesCore.hpp.

EdgeElementForcesAndSourcesCore

friend class EdgeElementForcesAndSourcesCore

friend

Definition at line 986 of file ForcesAndSourcesCore.hpp.

FaceElementForcesAndSourcesCore

friend class FaceElementForcesAndSourcesCore

friend

Definition at line 987 of file ForcesAndSourcesCore.hpp.

ForcesAndSourcesCore

friend class ForcesAndSourcesCore

friend

Definition at line 985 of file ForcesAndSourcesCore.hpp.

Member Data Documentation

colFieldName

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

Definition at line 575 of file ForcesAndSourcesCore.hpp.

opType

char MoFEM::ForcesAndSourcesCore::UserDataOperator::opType

Definition at line 573 of file ForcesAndSourcesCore.hpp.

OpTypeNames

const char *const ForcesAndSourcesCore::UserDataOperator::OpTypeNames

static

Initial value:

= {
    "OPROW", " OPCOL", "OPROWCOL", "OPSPACE", "OPLAST"}

Definition at line 571 of file ForcesAndSourcesCore.hpp.

ptrFE

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

protected

Definition at line 980 of file ForcesAndSourcesCore.hpp.

rowFieldName

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

Definition at line 574 of file ForcesAndSourcesCore.hpp.

sPace

FieldSpace MoFEM::ForcesAndSourcesCore::UserDataOperator::sPace

Definition at line 576 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