Operator for inverting matrices at integration points. More...

#include "src/finite_elements/UserDataOperators.hpp"

Inheritance diagram for MoFEM::OpInvertMatrix< DIM >:

Collaboration diagram for MoFEM::OpInvertMatrix< DIM >:

Public Member Functions
template<typename T >
	OpInvertMatrix (boost::shared_ptr< MatrixDouble > in_ptr, boost::shared_ptr< T > det_ptr, boost::shared_ptr< MatrixDouble > out_ptr)
	Constructor for matrix inversion operator.

Operation on matrices at integration points
MoFEMErrorCode	doWork (int side, EntityType type, EntitiesFieldData::EntData &data)
	Operator for linear form, usually to calculate values on right hand side.

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

KspMethod::KSPContext	getKSPCtx () const

SnesMethod::SNESContext	getSNESCtx () 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

MoFEM::Interface &	getMField ()

moab::Interface &	getMoab ()

virtual boost::weak_ptr< ForcesAndSourcesCore >	getSubPipelinePtr () const

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	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

Private Attributes
boost::shared_ptr< MatrixDouble >	inPtr

boost::shared_ptr< MatrixDouble >	outPtr

std::variant< boost::shared_ptr< VectorDouble >, boost::shared_ptr< MatrixDouble > >	detPtrVariant

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 Member Functions inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
virtual MoFEMErrorCode	setPtrFE (ForcesAndSourcesCore *ptr)

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

Detailed Description

template<int DIM>
struct MoFEM::OpInvertMatrix< DIM >

Operator for inverting matrices at integration points.

This template structure computes the inverse of square matrices and their determinants at integration points. It's commonly used in finite element methods for coordinate transformations, constitutive relations, and other matrix operations requiring matrix inversion.

Template Parameters

DIM	Dimension of the square matrix to be inverted

Examples: /home/lk58p/mofem_install/vanilla_dev_release/mofem-cephas/mofem/users_modules/eshelbian_plasticity/src/impl/EshelbianOperators.cpp, mofem/atom_tests/continuity_check_on_skeleton_3d.cpp, mofem/atom_tests/hcurl_check_approx_in_2d.cpp, mofem/atom_tests/hcurl_curl_operator.cpp, mofem/atom_tests/higher_derivatives.cpp, mofem/atom_tests/quad_polynomial_approximation.cpp, mofem/atom_tests/simple_interface.cpp, mofem/tutorials/adv-0_plasticity/plastic.cpp, mofem/tutorials/adv-4_dynamic_first_order_con_law/dynamic_first_order_con_law.cpp, mofem/tutorials/cor-2to5_analytical_poisson/src/PoissonOperators.hpp, mofem/tutorials/cor-6_simple_elasticity/simple_elasticity.cpp, mofem/tutorials/cor-9_reaction_diffusion/reaction_diffusion.cpp, mofem/tutorials/scl-6_heat_equation/heat_equation.cpp, mofem/tutorials/scl-7_wave_equation/wave_equation.cpp, mofem/tutorials/scl-8_heat_radiation/radiation.cpp, mofem/tutorials/scl-9_heat_method/heat_method.cpp, mofem/tutorials/vec-4_shallow_wave/shallow_wave.cpp, mofem/tutorials/vec-6_dg_kirchhoff_plate/plate.cpp, mofem/users_modules/basic_finite_elements/src/impl/NavierStokesElement.cpp, mofem/users_modules/minimal_surface_equation/minimal_surface_area.cpp, and plastic.cpp.

Definition at line 4418 of file UserDataOperators.hpp.

Constructor & Destructor Documentation

◆ OpInvertMatrix()

template<int DIM>

template<typename T >

MoFEM::OpInvertMatrix< DIM >::OpInvertMatrix	(	boost::shared_ptr< MatrixDouble >	in_ptr,
		boost::shared_ptr< T >	det_ptr,
		boost::shared_ptr< MatrixDouble >	out_ptr
	)

inline

Constructor for matrix inversion operator.

Parameters

in_ptr	Shared pointer to input matrix to be inverted
det_ptr	Shared pointer to vector for storing matrix determinants
out_ptr	Shared pointer to output matrix for storing inverted matrices

Definition at line 4428 of file UserDataOperators.hpp.

4431 : ForcesAndSourcesCore::UserDataOperator(NOSPACE), inPtr(in_ptr),

4432 outPtr(out_ptr), detPtrVariant(det_ptr) {}

NOSPACE

@ NOSPACE

Definition definitions.h:83

MoFEM::OpInvertMatrix::outPtr

boost::shared_ptr< MatrixDouble > outPtr

Definition UserDataOperators.hpp:4439

MoFEM::OpInvertMatrix::inPtr

boost::shared_ptr< MatrixDouble > inPtr

Definition UserDataOperators.hpp:4438

MoFEM::OpInvertMatrix::detPtrVariant

std::variant< boost::shared_ptr< VectorDouble >, boost::shared_ptr< MatrixDouble > > detPtrVariant

Definition UserDataOperators.hpp:4441

Member Function Documentation

◆ doWork()

template<int DIM>

MoFEMErrorCode MoFEM::OpInvertMatrix< DIM >::doWork	(	int	side,
		EntityType	type,
		EntitiesFieldData::EntData &	data
	)

virtual

Operator for linear form, usually to calculate values on right hand side.

Reimplemented from MoFEM::DataOperator.

Definition at line 4445 of file UserDataOperators.hpp.

                                                                           {
  MoFEMFunctionBegin;
 
#ifndef NDEBUG
  if (!inPtr)
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
            "Pointer for inPtr matrix not allocated");
 
  if (!std::holds_alternative<boost::shared_ptr<VectorDouble>>(detPtrVariant) &&
      !std::holds_alternative<boost::shared_ptr<MatrixDouble>>(detPtrVariant)) {
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
            "detPtrVariant must hold either VectorDouble or MatrixDouble");
  }
#endif
  const auto nb_integration_pts = inPtr->size1();
 
#ifndef NDEBUG
  const auto nb_rows = inPtr->size2();
  if (nb_rows != DIM * DIM)
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
            "Wrong number of matrix coefficients");
#endif
 
  std::visit(
    [&](auto ptr) {
      using T = std::decay_t<decltype(ptr)>;
 
      if constexpr (std::is_same_v<T, boost::shared_ptr<VectorDouble>>) {
        ptr->resize(nb_integration_pts, false);
      } else if constexpr (std::is_same_v<T, boost::shared_ptr<MatrixDouble>>) {
        ptr->resize(nb_integration_pts, 1, false);
      }
    },
    detPtrVariant);
 
  using DL = DataLayoutTraits<DataLayout::GaussByCoeffs>;
  auto get_in_at_pts =
      MatrixSizeHelper<GetFTensor2FromMatType<DIM, DIM, -1, DL>, DL>::get(
          *inPtr, nb_integration_pts);
 
  // Calculate determinant
  {
    auto t_in_at_pts = get_in_at_pts();
    auto det_it = std::visit(
        [](auto p) -> std::vector<double>::iterator {
          return p->data().begin();
        },
        detPtrVariant);
    for (size_t gg = 0; gg != nb_integration_pts; ++gg) {
      *det_it = determinantTensor(t_in_at_pts);
      ++t_in_at_pts;
      ++det_it;
    }
  }
 
  // Invert jacobian
  if (outPtr) {
    auto get_out_at_pts =
        MatrixSizeHelper<GetFTensor2FromMatType<DIM, DIM, -1, DL>, DL>::size(
            *outPtr, nb_integration_pts);
    auto t_in_at_pts = get_in_at_pts();
    auto t_out_at_pts = get_out_at_pts();
    auto det_it = std::visit(
        [](auto p) -> std::vector<double>::iterator {
          return p->data().begin();
        },
        detPtrVariant);
    for (size_t gg = 0; gg != nb_integration_pts; ++gg) {
      CHKERR invertTensor(t_in_at_pts, *det_it, t_out_at_pts);
      ++t_in_at_pts;
      ++t_out_at_pts;
      ++det_it;
    }
  }
 
  MoFEMFunctionReturn(0);
}

Member Data Documentation

◆ detPtrVariant

template<int DIM>

std::variant<boost::shared_ptr<VectorDouble>, boost::shared_ptr<MatrixDouble> > MoFEM::OpInvertMatrix< DIM >::detPtrVariant

private

Definition at line 4441 of file UserDataOperators.hpp.

◆ inPtr

template<int DIM>

boost::shared_ptr<MatrixDouble> MoFEM::OpInvertMatrix< DIM >::inPtr

private

Definition at line 4438 of file UserDataOperators.hpp.

◆ outPtr

template<int DIM>

boost::shared_ptr<MatrixDouble> MoFEM::OpInvertMatrix< DIM >::outPtr

private

Definition at line 4439 of file UserDataOperators.hpp.

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

src/finite_elements/UserDataOperators.hpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpInvertMatrix()

Member Function Documentation

◆ doWork()

Member Data Documentation

◆ detPtrVariant

◆ inPtr

◆ outPtr