Calculate scalar field values from PETSc vector at integration points. More...

#include "src/finite_elements/UserDataOperators.hpp"

Inheritance diagram for MoFEM::OpCalculateScalarFieldValuesFromPetscVecImpl< CTX >:

Collaboration diagram for MoFEM::OpCalculateScalarFieldValuesFromPetscVecImpl< CTX >:

Public Member Functions
	OpCalculateScalarFieldValuesFromPetscVecImpl (const std::string field_name, boost::shared_ptr< VectorDouble > data_ptr, const EntityType zero_at_type=MBVERTEX)
	Constructor for PETSc vector-based scalar field calculation.

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

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

const EntityHandle	zeroAtType

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<PetscData::DataContext CTX>
struct MoFEM::OpCalculateScalarFieldValuesFromPetscVecImpl< CTX >

Calculate scalar field values from PETSc vector at integration points.

This template structure extracts scalar field values from a PETSc vector and calculates them at integration points. It supports different data contexts through the template parameter and can handle various entity types.

Template Parameters

CTX	PETSc data context type specifying how data is accessed

Examples: mofem/tutorials/cor-9/reaction_diffusion.cpp.

Definition at line 282 of file UserDataOperators.hpp.

Constructor & Destructor Documentation

◆ OpCalculateScalarFieldValuesFromPetscVecImpl()

template<PetscData::DataContext CTX>

MoFEM::OpCalculateScalarFieldValuesFromPetscVecImpl< CTX >::OpCalculateScalarFieldValuesFromPetscVecImpl	(	const std::string	field_name,
		boost::shared_ptr< VectorDouble >	data_ptr,
		const EntityType	zero_at_type = `MBVERTEX`
	)

inline

Constructor for PETSc vector-based scalar field calculation.

Parameters

field_name	Name of the scalar field to extract values from
data_ptr	Shared pointer to VectorDouble for storing calculated values
zero_at_type	Entity type where values should be zeroed (default: MBVERTEX)

Definition at line 292 of file UserDataOperators.hpp.

      : ForcesAndSourcesCore::UserDataOperator(
            field_name, ForcesAndSourcesCore::UserDataOperator::OPROW),
        dataPtr(data_ptr), zeroAtType(zero_at_type) {
    if (!dataPtr)
      THROW_MESSAGE("Pointer is not set");
  }

Member Function Documentation

◆ doWork()

template<PetscData::DataContext CTX>

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

inlinevirtual

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

Reimplemented from MoFEM::DataOperator.

Definition at line 302 of file UserDataOperators.hpp.

                                                        {
    MoFEMFunctionBegin;
 
    const size_t nb_gauss_pts = getGaussPts().size2();
 
    VectorDouble &vec = *dataPtr;
    if (type == zeroAtType || vec.size() != nb_gauss_pts) {
      vec.resize(nb_gauss_pts, false);
      vec.clear();
    }
 
    auto &local_indices = data.getLocalIndices();
    const size_t nb_dofs = local_indices.size();
    if (nb_dofs) {
 
      const double *array;
 
      auto get_array = [&](const auto ctx, auto vec) {
        MoFEMFunctionBegin;
  #ifndef NDEBUG
        if ((getFEMethod()->data_ctx & ctx).none()) {
          MOFEM_LOG_CHANNEL("SELF");
          MOFEM_LOG("SELF", Sev::error)
              << "In this case field degrees of freedom are read from vector.  "
                 "That usually happens when time solver is used, and acces to "
                 "first or second rates is needed. You probably not set ts_u, "
                 "ts_u_t, or ts_u_tt and associated data structure, i.e. "
                 "data_ctx to CTX_SET_X, CTX_SET_X_T, or CTX_SET_X_TT "
                 "respectively";
          SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "Vector not set!");
        }
  #endif
        CHKERR VecGetArrayRead(vec, &array);
        MoFEMFunctionReturn(0);
      };
 
      auto restore_array = [&](auto vec) {
        return VecRestoreArrayRead(vec, &array);
      };
 
      switch (CTX) {
      case PetscData::CTX_SET_X:
        CHKERR get_array(PetscData::CtxSetX, getFEMethod()->ts_u);
        break;
      case PetscData::CTX_SET_X_T:
        CHKERR get_array(PetscData::CtxSetX_T, getFEMethod()->ts_u_t);
        break;
      case PetscData::CTX_SET_X_TT:
        CHKERR get_array(PetscData::CtxSetX_TT, getFEMethod()->ts_u_tt);
        break;
      default:
        SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
                "That case is not implemented");
      }
 
      std::array<double, MAX_DOFS_ON_ENTITY> dot_dofs_vector;
      for (int i = 0; i != local_indices.size(); ++i)
        if (local_indices[i] != -1)
          dot_dofs_vector[i] = array[local_indices[i]];
        else
          dot_dofs_vector[i] = 0;
 
      switch (CTX) {
      case PetscData::CTX_SET_X:
        CHKERR restore_array(getFEMethod()->ts_u);
        break;
      case PetscData::CTX_SET_X_T:
        CHKERR restore_array(getFEMethod()->ts_u_t);
        break;
      case PetscData::CTX_SET_X_TT:
        CHKERR restore_array(getFEMethod()->ts_u_tt);
        break;
      default:
        SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
                "That case is not implemented");
      }
 
      const size_t nb_base_functions = data.getN().size2();
      auto base_function = data.getFTensor0N();
      auto values_at_gauss_pts = getFTensor0FromVec(vec);
 
      for (size_t gg = 0; gg != nb_gauss_pts; ++gg) {
        size_t bb = 0;
        for (; bb != nb_dofs; ++bb) {
          values_at_gauss_pts += dot_dofs_vector[bb] * base_function;
          ++base_function;
        }
        // Number of dofs can be smaller than number of Tensor_Dim x base
        // functions
        for (; bb < nb_base_functions; ++bb)
          ++base_function;
        ++values_at_gauss_pts;
      }
    }
    MoFEMFunctionReturn(0);
  }