default operator for TET element More...

#include "src/finite_elements/VolumeElementForcesAndSourcesCoreOnSide.hpp"

Inheritance diagram for MoFEM::VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator:

Collaboration diagram for MoFEM::VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator:

Public Member Functions
VolumeElementForcesAndSourcesCoreOnSide *	getVolumeFE () const
	Access the owning volume finite element.

FaceElementForcesAndSourcesCore *	getFaceFE () const
	Access the face finite element Face element, execute side element, that is volume, on which the volume side operators are executed.

DEPRECATED int	getFaceSense () const
	Get face sense with respect to the volume.

int	getSkeletonSense () const
	Get the skeleton sense.

int	getFaceSideNumber () const
	Get face side number with respect to the volume.

bool	getEdgeFace (const int ee) const
	Query if an edge belongs to the current face.

VectorDouble &	getNormal ()
	Get the face normal for this side element.

VectorDouble &	getTangent1 ()
	Get first triangle tangent.

VectorDouble &	getTangent2 ()
	Get second triangle tangent.

auto	getFTensor1Normal ()
	Get normal as tensor.

auto	getFTensor1Tangent1 ()
	Get tangent one as tensor.

auto	getFTensor1Tangent2 ()
	Get tangent two as tensor.

MatrixDouble &	getNormalsAtGaussPts ()
	If higher-order geometry is available, return normals at Gauss points.

ublas::matrix_row< MatrixDouble >	getNormalsAtGaussPts (const int gg)
	If higher-order geometry is available, return normals at Gauss points.

auto	getFTensor1NormalsAtGaussPts ()
	Get normal at integration points.

MatrixDouble &	getFaceCoordsAtGaussPts ()
	Get face coordinates at Gauss points.

Public Member Functions inherited from MoFEM::VolumeElementForcesAndSourcesCore::UserDataOperator
int	getNumNodes ()
	get element number of nodes

const EntityHandle *	getConn ()
	get element connectivity

double	getVolume () const
	element volume (linear geometry)

double &	getVolume ()
	element volume (linear geometry)

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

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

VectorDouble &	getCoords ()
	nodal coordinates

VolumeElementForcesAndSourcesCore *	getVolumeFE () const
	return pointer to Generic Volume Finite Element object

Public Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
	UserDataOperator (const FieldSpace space, const char type=OPSPACE, const bool symm=true)
	Constructor for operators working on finite element spaces.

	UserDataOperator (const std::string field_name, const char type, const bool symm=true)
	Constructor for operators working on a single field.

	UserDataOperator (const std::string row_field_name, const std::string col_field_name, const char type, const bool symm=true)
	Constructor for operators working on two fields (bilinear forms)

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

EntityHandle	getFEEntityHandle () const
	Return finite element entity handle.

int	getFEDim () const
	Get dimension of finite element.

EntityType	getFEType () const
	Get dimension of finite element.

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

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

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

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

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

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

int	getOpType () const
	Get operator types.

void	setOpType (const OpType type)
	Set operator type.

void	addOpType (const OpType type)
	Add operator type.

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

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

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

ForcesAndSourcesCore *	getPtrFE () const

ForcesAndSourcesCore *	getSidePtrFE () const

ForcesAndSourcesCore *	getRefinePtrFE () const

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

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

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

auto	getFTensor0IntegrationWeight ()
	Get integration weights.

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

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

double	getMeasure () const
	get measure of element

double &	getMeasure ()
	get measure of element

MoFEMErrorCode	loopSide (const string &fe_name, ForcesAndSourcesCore side_fe, const size_t dim, const EntityHandle ent_for_side=0, boost::shared_ptr< Range > fe_range=nullptr, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy, AdjCache adj_cache=nullptr)
	User calls this function to loop over elements on the side of face. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopThis (const string &fe_name, ForcesAndSourcesCore *this_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over the same element using a different set of integration points. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopParent (const string &fe_name, ForcesAndSourcesCore *parent_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over parent elements. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopChildren (const string &fe_name, ForcesAndSourcesCore *child_fe, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	User calls this function to loop over parent elements. This function calls finite element with its operator to do calculations.

MoFEMErrorCode	loopRange (const string &fe_name, ForcesAndSourcesCore *range_fe, boost::shared_ptr< Range > fe_range, const int verb=QUIET, const LogManager::SeverityLevel sev=Sev::noisy)
	Iterate over range of elements.

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.

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.

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

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

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

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

Protected Member Functions
MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)
	Assign base class pointer for the operator.

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

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

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 Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
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.

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

bool &	doVertices
	\deprectaed If false skip vertices

bool &	doEdges
	\deprectaed If false skip edges

bool &	doQuads
	\deprectaed

bool &	doTris
	\deprectaed

bool &	doTets
	\deprectaed

bool &	doPrisms
	\deprectaed

Static Public Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
static const char *const	OpTypeNames []

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

Detailed Description

default operator for TET element

Examples: mofem/atom_tests/continuity_check_on_skeleton_3d.cpp, mofem/tutorials/fun-0/hello_world.cpp, and mofem/users_modules/eshelbian_plasticity/src/impl/EshelbianPlasticity.cpp.

Definition at line 146 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

Member Function Documentation

◆ getEdgeFace()

bool VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getEdgeFace ( const int ee ) const

inline

Query if an edge belongs to the current face.

Parameters

ee	Local edge index (0-5 for tetrahedra)

Returns: True when the edge lies on the active face

Definition at line 370 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                        {
  constexpr bool edges_on_faces[6][4] = {{true, false, false, true}, // e0
                                         {false, true, false, true}, // e1
                                         {false, false, true, true}, // e2
                                         {true, false, true, false}, // e3
                                         {true, true, false, false}, // e4
                                         {false, true, true, false}};
  return edges_on_faces[ee][getFaceSideNumber()];
}

◆ getFaceCoordsAtGaussPts()

MatrixDouble & VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFaceCoordsAtGaussPts ( )

inline

Get face coordinates at Gauss points.

Note: Coordinates should match the values returned by getCoordsAtGaussPts on tetrahedra. If they differ, it indicates an error or an unusual setup.

Definition at line 365 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                              {
  return getFaceFE()->coordsAtGaussPts;
}

◆ getFaceFE()

FaceElementForcesAndSourcesCore * VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFaceFE ( ) const

inline

Access the face finite element Face element, execute side element, that is volume, on which the volume side operators are executed.

Returns: Pointer to the face finite element attached to this side

Definition at line 295 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                                                                         {
  return static_cast<FaceElementForcesAndSourcesCore *>(
      getVolumeFE()->sidePtrFE);
}

◆ getFaceSense()

int VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFaceSense ( ) const

inline

Get face sense with respect to the volume.

Deprecated:: Use getSkeletonSense()

Returns: Face sense (+1 or -1)

Definition at line 320 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

          {
  return getSkeletonSense();
}

◆ getFaceSideNumber()

int VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFaceSideNumber ( ) const

inline

Get face side number with respect to the volume.

Returns: Face side number

Definition at line 355 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                              {
  return getVolumeFE()->faceSideNumber;
}

◆ getFTensor1Normal()

auto VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFTensor1Normal ( )

inline

Get normal as tensor.

Definition at line 330 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                        {
  double *ptr = &*getNormal().data().begin();
  return FTensor::Tensor1<double *, 3>(ptr, &ptr[1], &ptr[2]);
}

◆ getFTensor1NormalsAtGaussPts()

auto VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFTensor1NormalsAtGaussPts ( )

inline

Get normal at integration points.

Example:

double nrm2;
FTensor::Index<'i',3> i;
auto t_normal = getFTensor1NormalsAtGaussPts();
for(int gg = gg!=data.getN().size1();gg++) {
  nrm2 = sqrt(t_normal(i)*t_normal(i));
  ++t_normal;
}

Definition at line 348 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

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

◆ getFTensor1Tangent1()

auto VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFTensor1Tangent1 ( )

inline

Get tangent one as tensor.

Definition at line 336 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                          {
  double *ptr = &*getTangent1().data().begin();
  return FTensor::Tensor1<double *, 3>(ptr, &ptr[1], &ptr[2]);
}

◆ getFTensor1Tangent2()

auto VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getFTensor1Tangent2 ( )

inline

Get tangent two as tensor.

Definition at line 342 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                          {
  double *ptr = &*getTangent2().data().begin();
  return FTensor::Tensor1<double *, 3>(ptr, &ptr[1], &ptr[2]);
}

◆ getNormal()

VectorDouble & VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getNormal ( )

inline

Get the face normal for this side element.

Returns: Face normal vector

Definition at line 301 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                                                                   {
  return getFaceFE()->nOrmal;
}

◆ getNormalsAtGaussPts() [1/2]

MatrixDouble & VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getNormalsAtGaussPts ( )

inline

If higher-order geometry is available, return normals at Gauss points.

Note: The returned matrix has zero rows and columns when no higher-order approximation of geometry is available.

Definition at line 360 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                           {
  return getFaceFE()->normalsAtGaussPts;
}

◆ getNormalsAtGaussPts() [2/2]

ublas::matrix_row< MatrixDouble > VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getNormalsAtGaussPts ( const int gg )

inline

If higher-order geometry is available, return normals at Gauss points.

Parameters

gg	Gauss point number

Definition at line 382 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                  {
  return ublas::matrix_row<MatrixDouble>(getNormalsAtGaussPts(), gg);
}

◆ getSkeletonSense()

int VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getSkeletonSense ( ) const

inline

Get the skeleton sense.

Calls getFaceSense().

Returns: Skeleton sense (+1 or -1)

Definition at line 325 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                             {
  return getVolumeFE()->faceSense;
}

◆ getTangent1()

VectorDouble & VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getTangent1 ( )

inline

Get first triangle tangent.

Definition at line 306 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                                                                     {
  return getFaceFE()->tangentOne;
}

◆ getTangent2()

VectorDouble & VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getTangent2 ( )

inline

Get second triangle tangent.

Definition at line 311 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

                                                                     {
  return getFaceFE()->tangentTwo;
}

◆ getVolumeFE()

VolumeElementForcesAndSourcesCoreOnSide * VolumeElementForcesAndSourcesCoreOnSide::UserDataOperator::getVolumeFE ( ) const

inline

Access the owning volume finite element.

Volume element is side element, to face element.

Returns: Pointer to the parent volume finite element

Definition at line 316 of file VolumeElementForcesAndSourcesCoreOnSide.hpp.

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

◆ setPtrFE()

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

protectedvirtual

Assign base class pointer for the operator.

Parameters

ptr	Pointer to the forces and sources core instance

Returns: Error code (0 on success)

Reimplemented from MoFEM::VolumeElementForcesAndSourcesCore::UserDataOperator.

Definition at line 70 of file VolumeElementForcesAndSourcesCoreOnSide.cpp.

                               {
  MoFEMFunctionBeginHot;
  if (!(ptrFE = dynamic_cast<VolumeElementForcesAndSourcesCoreOnSide *>(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/VolumeElementForcesAndSourcesCoreOnSide.hpp
src/finite_elements/impl/VolumeElementForcesAndSourcesCoreOnSide.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getEdgeFace()

◆ getFaceCoordsAtGaussPts()

◆ getFaceFE()

◆ getFaceSense()

◆ getFaceSideNumber()

◆ getFTensor1Normal()

◆ getFTensor1NormalsAtGaussPts()

◆ getFTensor1Tangent1()

◆ getFTensor1Tangent2()

◆ getNormal()

◆ getNormalsAtGaussPts() [1/2]

◆ getNormalsAtGaussPts() [2/2]

◆ getSkeletonSense()

◆ getTangent1()

◆ getTangent2()

◆ getVolumeFE()

◆ setPtrFE()