v0.15.0
Loading...
Searching...
No Matches
MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX > Struct Template Reference

Approximate field values for given petsc vector. More...

#include "src/finite_elements/UserDataOperators.hpp"

Inheritance diagram for MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >:
[legend]
Collaboration diagram for MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >:
[legend]

Public Member Functions

 OpCalculateVectorFieldValuesFromPetscVecImpl (const std::string field_name, boost::shared_ptr< MatrixDouble > data_ptr, const EntityType zero_at_type=MBVERTEX, bool throw_error=true)
 
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)
 
 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 NumeredEntFiniteElementgetNumeredEntFiniteElementPtr () 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< SideNumbergetSideNumberPtr (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 FEMethodgetFEMethod () 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.
 
ForcesAndSourcesCoregetPtrFE () const
 
ForcesAndSourcesCoregetSidePtrFE () const
 
ForcesAndSourcesCoregetRefinePtrFE () const
 
const PetscData::SwitchesgetDataCtx () 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
 
MatrixDoublegetGaussPts ()
 matrix of integration (Gauss) points for Volume Element
 
auto getFTensor0IntegrationWeight ()
 Get integration weights.
 
MatrixDoublegetCoordsAtGaussPts ()
 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
 
doublegetMeasure ()
 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
 

Protected Attributes

boost::shared_ptr< MatrixDoubledataPtr
 
const EntityHandle zeroAtType
 
VectorDouble dotVector
 
bool throwError
 
- Protected Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
ForcesAndSourcesCoreptrFE
 

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
 
- Public Types inherited from MoFEM::DataOperator
using DoWorkLhsHookFunType
 
using DoWorkRhsHookFunType
 
- 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.
 
booldoVertices
 \deprectaed If false skip vertices
 
booldoEdges
 \deprectaed If false skip edges
 
booldoQuads
 \deprectaed
 
booldoTris
 \deprectaed
 
booldoTets
 \deprectaed
 
booldoPrisms
 \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)
 

Detailed Description

template<int Tensor_Dim, PetscData::DataContext CTX>
struct MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >

Approximate field values for given petsc vector.

Note
Look at PetscData to see what vectors could be extracted with that user data operator.
Examples
EshelbianPlasticity.cpp, approx_sphere.cpp, free_surface.cpp, operators_tests.cpp, plastic.cpp, and shallow_wave.cpp.

Definition at line 597 of file UserDataOperators.hpp.

Constructor & Destructor Documentation

◆ OpCalculateVectorFieldValuesFromPetscVecImpl()

template<int Tensor_Dim, PetscData::DataContext CTX>
MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >::OpCalculateVectorFieldValuesFromPetscVecImpl ( const std::string field_name,
boost::shared_ptr< MatrixDouble > data_ptr,
const EntityType zero_at_type = MBVERTEX,
bool throw_error = true )
inline

Definition at line 600 of file UserDataOperators.hpp.

604 field_name, ForcesAndSourcesCore::UserDataOperator::OPROW),
605 dataPtr(data_ptr), zeroAtType(zero_at_type), throwError(throw_error) {
606 if (!dataPtr)
607 THROW_MESSAGE("Pointer is not set");
608 }
#define THROW_MESSAGE(msg)
Throw MoFEM exception.
constexpr auto field_name

Member Function Documentation

◆ doWork()

template<int Tensor_Dim, PetscData::DataContext CTX>
MoFEMErrorCode MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, 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 610 of file UserDataOperators.hpp.

611 {
613
614 auto &local_indices = data.getLocalIndices();
615 const size_t nb_dofs = local_indices.size();
616 const size_t nb_gauss_pts = getGaussPts().size2();
617
618 MatrixDouble &mat = *dataPtr;
619 if (type == zeroAtType) {
620 mat.resize(Tensor_Dim, nb_gauss_pts, false);
621 mat.clear();
622 }
623 if (!nb_dofs)
625
626 if (!throwError) {
627 if ((getFEMethod()->data_ctx & PetscData::Switches(CTX)).none()) {
629 }
630 }
631
632 const double *array;
633
634 auto get_array = [&](const auto ctx, auto vec) {
636 #ifndef NDEBUG
637 if ((getFEMethod()->data_ctx & ctx).none()) {
638 MOFEM_LOG_CHANNEL("SELF");
639 MOFEM_LOG("SELF", Sev::error)
640 << "In this case field degrees of freedom are read from vector. "
641 "That usually happens when time solver is used, and access to "
642 "first or second rates is needed. You probably not set ts_u, "
643 "ts_u_t, or ts_u_tt and associated data structure, i.e. "
644 "data_ctx to CTX_SET_X, CTX_SET_DX, CTX_SET_X_T, or "
645 "CTX_SET_X_TT respectively";
646 SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "Vector not set");
647 }
648 #endif
649 CHKERR VecGetArrayRead(vec, &array);
651 };
652
653 auto restore_array = [&](auto vec) {
654 return VecRestoreArrayRead(vec, &array);
655 };
656
657 switch (CTX) {
659 CHKERR get_array(PetscData::CtxSetX, getFEMethod()->ts_u);
660 break;
662 CHKERR get_array(PetscData::CtxSetX, getFEMethod()->dx);
663 break;
665 CHKERR get_array(PetscData::CtxSetX_T, getFEMethod()->ts_u_t);
666 break;
668 CHKERR get_array(PetscData::CtxSetX_TT, getFEMethod()->ts_u_tt);
669 break;
670 default:
671 SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
672 "That case is not implemented");
673 }
674
675 dotVector.resize(local_indices.size());
676 for (int i = 0; i != local_indices.size(); ++i)
677 if (local_indices[i] != -1)
678 dotVector[i] = array[local_indices[i]];
679 else
680 dotVector[i] = 0;
681
682 switch (CTX) {
684 CHKERR restore_array(getFEMethod()->ts_u);
685 break;
687 CHKERR restore_array(getFEMethod()->dx);
688 break;
690 CHKERR restore_array(getFEMethod()->ts_u_t);
691 break;
693 CHKERR restore_array(getFEMethod()->ts_u_tt);
694 break;
695 default:
696 SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
697 "That case is not implemented");
698 }
699
700 const size_t nb_base_functions = data.getN().size2();
701 auto base_function = data.getFTensor0N();
702 auto values_at_gauss_pts = getFTensor1FromMat<Tensor_Dim>(mat);
703
704 FTensor::Index<'I', Tensor_Dim> I;
705 const size_t size = nb_dofs / Tensor_Dim;
706 if (nb_dofs % Tensor_Dim) {
707 SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "Data inconsistency");
708 }
709 for (size_t gg = 0; gg != nb_gauss_pts; ++gg) {
711 size_t bb = 0;
712 for (; bb != size; ++bb) {
713 values_at_gauss_pts(I) += field_data(I) * base_function;
714 ++field_data;
715 ++base_function;
716 }
717 // Number of dofs can be smaller than number of Tensor_Dim x base
718 // functions
719 for (; bb < nb_base_functions; ++bb)
720 ++base_function;
721 ++values_at_gauss_pts;
722 }
724 }
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return()
#define MoFEMFunctionBegin
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
@ MOFEM_DATA_INCONSISTENCY
Definition definitions.h:31
@ MOFEM_NOT_IMPLEMENTED
Definition definitions.h:32
#define MoFEMFunctionReturn(a)
Last executable line of each PETSc function used for error handling. Replaces return()
#define CHKERR
Inline error check.
#define MOFEM_LOG(channel, severity)
Log.
#define MOFEM_LOG_CHANNEL(channel)
Set and reset channel.
FTensor::Index< 'i', SPACE_DIM > i
FTensor::Tensor1< FTensor::PackPtr< T *, S >, Tensor_Dim > getFTensor1FromMat(ublas::matrix< T, L, A > &data)
Get tensor rank 1 (vector) form data matrix.
auto getFTensor1FromArray(VectorDouble &data)
Get FTensor1 from array.
constexpr IntegrationType I
const FEMethod * getFEMethod() const
Return raw pointer to Finite Element Method object.
MatrixDouble & getGaussPts()
matrix of integration (Gauss) points for Volume Element
static constexpr Switches CtxSetX
static constexpr Switches CtxSetX_TT
std::bitset< 8 > Switches
static constexpr Switches CtxSetX_T

Member Data Documentation

◆ dataPtr

template<int Tensor_Dim, PetscData::DataContext CTX>
boost::shared_ptr<MatrixDouble> MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >::dataPtr
protected

Definition at line 727 of file UserDataOperators.hpp.

◆ dotVector

template<int Tensor_Dim, PetscData::DataContext CTX>
VectorDouble MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >::dotVector
protected

Definition at line 729 of file UserDataOperators.hpp.

◆ throwError

template<int Tensor_Dim, PetscData::DataContext CTX>
bool MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >::throwError
protected

Definition at line 730 of file UserDataOperators.hpp.

◆ zeroAtType

template<int Tensor_Dim, PetscData::DataContext CTX>
const EntityHandle MoFEM::OpCalculateVectorFieldValuesFromPetscVecImpl< Tensor_Dim, CTX >::zeroAtType
protected

Definition at line 728 of file UserDataOperators.hpp.


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