v0.15.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
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)
 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 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 = 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.
 
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
mofem/atom_tests/operators_tests.cpp, mofem/tutorials/adv-0/plastic.cpp, mofem/tutorials/vec-3/nonlinear_dynamic_elastic.cpp, mofem/tutorials/vec-4/approx_sphere.cpp, mofem/tutorials/vec-4/shallow_wave.cpp, mofem/tutorials/vec-5/free_surface.cpp, and mofem/users_modules/eshelbian_plasticity/src/impl/EshelbianPlasticity.cpp.

Definition at line 766 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 769 of file UserDataOperators.hpp.

772 : ForcesAndSourcesCore::UserDataOperator(
773 field_name, ForcesAndSourcesCore::UserDataOperator::OPROW),
774 dataPtr(data_ptr), zeroAtType(zero_at_type), throwError(throw_error) {
775 if (!dataPtr)
776 THROW_MESSAGE("Pointer is not set");
777 }
#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 779 of file UserDataOperators.hpp.

780 {
782
783 auto &local_indices = data.getLocalIndices();
784 const size_t nb_dofs = local_indices.size();
785 const size_t nb_gauss_pts = getGaussPts().size2();
786
787 MatrixDouble &mat = *dataPtr;
788 if (type == zeroAtType) {
789 mat.resize(Tensor_Dim, nb_gauss_pts, false);
790 mat.clear();
791 }
792 if (!nb_dofs)
794
795 if (!throwError) {
796 if ((getFEMethod()->data_ctx & PetscData::Switches(CTX)).none()) {
798 }
799 }
800
801 const double *array;
802
803 auto get_array = [&](const auto ctx, auto vec) {
805 #ifndef NDEBUG
806 if ((getFEMethod()->data_ctx & ctx).none()) {
807 MOFEM_LOG_CHANNEL("SELF");
808 MOFEM_LOG("SELF", Sev::error)
809 << "In this case field degrees of freedom are read from vector. "
810 "That usually happens when time solver is used, and access to "
811 "first or second rates is needed. You probably not set ts_u, "
812 "ts_u_t, or ts_u_tt and associated data structure, i.e. "
813 "data_ctx to CTX_SET_X, CTX_SET_DX, CTX_SET_X_T, or "
814 "CTX_SET_X_TT respectively";
815 SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "Vector not set");
816 }
817 #endif
818 CHKERR VecGetArrayRead(vec, &array);
820 };
821
822 auto restore_array = [&](auto vec) {
823 return VecRestoreArrayRead(vec, &array);
824 };
825
826 switch (CTX) {
828 CHKERR get_array(PetscData::CtxSetX, getFEMethod()->ts_u);
829 break;
831 CHKERR get_array(PetscData::CtxSetX, getFEMethod()->dx);
832 break;
834 CHKERR get_array(PetscData::CtxSetX_T, getFEMethod()->ts_u_t);
835 break;
837 CHKERR get_array(PetscData::CtxSetX_TT, getFEMethod()->ts_u_tt);
838 break;
839 default:
840 SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
841 "That case is not implemented");
842 }
843
844 dotVector.resize(local_indices.size());
845 for (int i = 0; i != local_indices.size(); ++i)
846 if (local_indices[i] != -1)
847 dotVector[i] = array[local_indices[i]];
848 else
849 dotVector[i] = 0;
850
851 switch (CTX) {
853 CHKERR restore_array(getFEMethod()->ts_u);
854 break;
856 CHKERR restore_array(getFEMethod()->dx);
857 break;
859 CHKERR restore_array(getFEMethod()->ts_u_t);
860 break;
862 CHKERR restore_array(getFEMethod()->ts_u_tt);
863 break;
864 default:
865 SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
866 "That case is not implemented");
867 }
868
869 const size_t nb_base_functions = data.getN().size2();
870 auto base_function = data.getFTensor0N();
871 auto values_at_gauss_pts = getFTensor1FromMat<Tensor_Dim>(mat);
872
873 FTensor::Index<'I', Tensor_Dim> I;
874 const size_t size = nb_dofs / Tensor_Dim;
875 if (nb_dofs % Tensor_Dim) {
876 SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "Data inconsistency");
877 }
878 for (size_t gg = 0; gg != nb_gauss_pts; ++gg) {
879 auto field_data = getFTensor1FromArray<Tensor_Dim, Tensor_Dim>(dotVector);
880 size_t bb = 0;
881 for (; bb != size; ++bb) {
882 values_at_gauss_pts(I) += field_data(I) * base_function;
883 ++field_data;
884 ++base_function;
885 }
886 // Number of dofs can be smaller than number of Tensor_Dim x base
887 // functions
888 for (; bb < nb_base_functions; ++bb)
889 ++base_function;
890 ++values_at_gauss_pts;
891 }
893 }
#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
UBlasMatrix< double > MatrixDouble
Definition Types.hpp:77
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
Solution vector switch.
static constexpr Switches CtxSetX_TT
Second time derivative switch.
std::bitset< 8 > Switches
Bitset type for context switches.
static constexpr Switches CtxSetX_T
First time derivative switch.
@ CTX_SET_X_T
Time derivative X_t is set.
@ CTX_SET_DX
Solution increment DX is set.
@ CTX_SET_X
Solution vector X is set.
@ CTX_SET_X_TT
Second time derivative X_tt is set.

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 896 of file UserDataOperators.hpp.

◆ dotVector

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

Definition at line 898 of file UserDataOperators.hpp.

◆ throwError

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

Definition at line 899 of file UserDataOperators.hpp.

◆ zeroAtType

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

Definition at line 897 of file UserDataOperators.hpp.


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