v0.14.0
Public Member Functions | Protected Attributes | List of all members
MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM > Struct Template Reference

Calculate field values (template specialization) for tensor field rank 1, i.e. vector field. More...

#include <src/finite_elements/UserDataOperators.hpp>

Inheritance diagram for MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >:
[legend]
Collaboration diagram for MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >:
[legend]

Public Member Functions

 OpCalculateDivergenceVectorFieldValues (const std::string field_name, boost::shared_ptr< VectorDouble > data_ptr, const EntityType zero_type=MBVERTEX)
 
MoFEMErrorCode doWork (int side, EntityType type, EntitiesFieldData::EntData &data)
 Operator for linear form, usually to calculate values on right hand side. More...
 
- 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 NumeredEntFiniteElement > getNumeredEntFiniteElementPtr () const
 Return raw pointer to NumeredEntFiniteElement. More...
 
EntityHandle getFEEntityHandle () const
 Return finite element entity handle. More...
 
int getFEDim () const
 Get dimension of finite element. More...
 
EntityType getFEType () const
 Get dimension of finite element. More...
 
boost::weak_ptr< SideNumber > getSideNumberPtr (const int side_number, const EntityType type)
 Get the side number pointer. More...
 
EntityHandle getSideEntity (const int side_number, const EntityType type)
 Get the side entity. More...
 
int getNumberOfNodesOnElement () const
 Get the number of nodes on finite element. More...
 
MoFEMErrorCode getProblemRowIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
 Get row indices. More...
 
MoFEMErrorCode getProblemColIndices (const std::string filed_name, const EntityType type, const int side, VectorInt &indices) const
 Get col indices. More...
 
const FEMethod * getFEMethod () const
 Return raw pointer to Finite Element Method object. More...
 
int getOpType () const
 Get operator types. More...
 
void setOpType (const OpType type)
 Set operator type. More...
 
void addOpType (const OpType type)
 Add operator type. More...
 
int getNinTheLoop () const
 get number of finite element in the loop More...
 
int getLoopSize () const
 get size of elements in the loop More...
 
std::string getFEName () const
 Get name of the element. More...
 
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 More...
 
auto getFTensor0IntegrationWeight ()
 Get integration weights. More...
 
MatrixDouble & getCoordsAtGaussPts ()
 Gauss points and weight, matrix (nb. of points x 3) More...
 
auto getFTensor1CoordsAtGaussPts ()
 Get coordinates at integration points assuming linear geometry. More...
 
double getMeasure () const
 get measure of element More...
 
double & getMeasure ()
 get measure of element More...
 
MoFEMErrorCode loopSide (const string &fe_name, ForcesAndSourcesCore *side_fe, const size_t dim, const EntityHandle ent_for_side=0, 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. More...
 
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. More...
 
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. More...
 
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. More...
 
- 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. More...
 
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. More...
 
void setSymm ()
 set if operator is executed taking in account symmetry More...
 
void unSetSymm ()
 unset if operator is executed for non symmetric problem More...
 

Protected Attributes

boost::shared_ptr< VectorDouble > dataPtr
 
const EntityHandle zeroType
 
- Protected Attributes inherited from MoFEM::ForcesAndSourcesCore::UserDataOperator
ForcesAndSourcesCore * ptrFE
 

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. More...
 
std::array< bool, MBMAXTYPE > doEntities
 If true operator is executed for entity. More...
 
bool & doVertices
 \deprectaed If false skip vertices More...
 
bool & doEdges
 \deprectaed If false skip edges More...
 
bool & doQuads
 \deprectaed More...
 
bool & doTris
 \deprectaed More...
 
bool & doTets
 \deprectaed More...
 
bool & doPrisms
 \deprectaed More...
 
- 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, CoordinateTypes COORDINATE_SYSTEM = CARTESIAN>
struct MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >

Calculate field values (template specialization) for tensor field rank 1, i.e. vector field.

Examples
free_surface.cpp, and shallow_wave.cpp.

Definition at line 486 of file UserDataOperators.hpp.

Constructor & Destructor Documentation

◆ OpCalculateDivergenceVectorFieldValues()

template<int Tensor_Dim, CoordinateTypes COORDINATE_SYSTEM = CARTESIAN>
MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >::OpCalculateDivergenceVectorFieldValues ( const std::string  field_name,
boost::shared_ptr< VectorDouble >  data_ptr,
const EntityType  zero_type = MBVERTEX 
)
inline

Definition at line 489 of file UserDataOperators.hpp.

492  : ForcesAndSourcesCore::UserDataOperator(
493  field_name, ForcesAndSourcesCore::UserDataOperator::OPROW),
494  dataPtr(data_ptr), zeroType(zero_type) {
495  if (!dataPtr)
496  THROW_MESSAGE("Pointer is not set");
497  }

Member Function Documentation

◆ doWork()

template<int Tensor_Dim, CoordinateTypes COORDINATE_SYSTEM = CARTESIAN>
MoFEMErrorCode MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >::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 499 of file UserDataOperators.hpp.

500  {
501  MoFEMFunctionBegin;
502 
503  // When we move to C++17 add if constexpr()
504  if constexpr (COORDINATE_SYSTEM == POLAR || COORDINATE_SYSTEM == SPHERICAL)
505  SETERRQ1(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
506  "%s coordiante not implemented",
507  CoordinateTypesNames[COORDINATE_SYSTEM]);
508 
509  const size_t nb_gauss_pts = getGaussPts().size2();
510  auto &vec = *dataPtr;
511  if (type == zeroType) {
512  vec.resize(nb_gauss_pts, false);
513  vec.clear();
514  }
515 
516  const size_t nb_dofs = data.getFieldData().size();
517  if (nb_dofs) {
518 
519  if (nb_gauss_pts) {
520  const size_t nb_base_functions = data.getN().size2();
521  auto values_at_gauss_pts = getFTensor0FromVec(vec);
522  FTensor::Index<'I', Tensor_Dim> I;
523  const size_t size = nb_dofs / Tensor_Dim;
524 #ifndef NDEBUG
525  if (nb_dofs % Tensor_Dim) {
526  SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
527  "Number of dofs should multiple of dimensions");
528  }
529 #endif
530 
531  // When we move to C++17 add if constexpr()
532  if constexpr (COORDINATE_SYSTEM == CARTESIAN) {
533  auto diff_base_function = data.getFTensor1DiffN<Tensor_Dim>();
534  for (size_t gg = 0; gg != nb_gauss_pts; ++gg) {
535  auto field_data = data.getFTensor1FieldData<Tensor_Dim>();
536  size_t bb = 0;
537  for (; bb != size; ++bb) {
538  values_at_gauss_pts += field_data(I) * diff_base_function(I);
539  ++field_data;
540  ++diff_base_function;
541  }
542  // Number of dofs can be smaller than number of Tensor_Dim x base
543  // functions
544  for (; bb < nb_base_functions; ++bb)
545  ++diff_base_function;
546  ++values_at_gauss_pts;
547  }
548  }
549 
550  // When we move to C++17 add if constexpr()
551  if constexpr (COORDINATE_SYSTEM == CYLINDRICAL) {
552  auto t_coords = getFTensor1CoordsAtGaussPts();
553  auto values_at_gauss_pts = getFTensor0FromVec(vec);
554  auto base_function = data.getFTensor0N();
555  auto diff_base_function = data.getFTensor1DiffN<Tensor_Dim>();
556  for (size_t gg = 0; gg != nb_gauss_pts; ++gg) {
557  auto field_data = data.getFTensor1FieldData<Tensor_Dim>();
558  size_t bb = 0;
559  for (; bb != size; ++bb) {
560  values_at_gauss_pts += field_data(I) * diff_base_function(I);
561  values_at_gauss_pts +=
562  base_function * (field_data(0) / t_coords(0));
563  ++field_data;
564  ++base_function;
565  ++diff_base_function;
566  }
567  // Number of dofs can be smaller than number of Tensor_Dim x base
568  // functions
569  for (; bb < nb_base_functions; ++bb) {
570  ++base_function;
571  ++diff_base_function;
572  }
573  ++values_at_gauss_pts;
574  ++t_coords;
575  }
576  }
577  }
578  }
579  MoFEMFunctionReturn(0);
580  }

Member Data Documentation

◆ dataPtr

template<int Tensor_Dim, CoordinateTypes COORDINATE_SYSTEM = CARTESIAN>
boost::shared_ptr<VectorDouble> MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >::dataPtr
protected

Definition at line 583 of file UserDataOperators.hpp.

◆ zeroType

template<int Tensor_Dim, CoordinateTypes COORDINATE_SYSTEM = CARTESIAN>
const EntityHandle MoFEM::OpCalculateDivergenceVectorFieldValues< Tensor_Dim, COORDINATE_SYSTEM >::zeroType
protected

Definition at line 584 of file UserDataOperators.hpp.

The documentation for this struct was generated from the following file:
CARTESIAN
@ CARTESIAN
Definition: definitions.h:115
THROW_MESSAGE
#define THROW_MESSAGE(msg)
Throw MoFEM exception.
Definition: definitions.h:561
I
constexpr IntegrationType I
Definition: operators_tests.cpp:31
MoFEM::ForcesAndSourcesCore::UserDataOperator::getGaussPts
MatrixDouble & getGaussPts()
matrix of integration (Gauss) points for Volume Element
Definition: ForcesAndSourcesCore.hpp:1235
CoordinateTypesNames
const static char *const CoordinateTypesNames[]
Coordinate system names.
Definition: definitions.h:108
POLAR
@ POLAR
Definition: definitions.h:116
convert.type
type
Definition: convert.py:64
MoFEM::getFTensor0FromVec
static auto getFTensor0FromVec(ublas::vector< T, A > &data)
Get tensor rank 0 (scalar) form data vector.
Definition: Templates.hpp:135
SPHERICAL
@ SPHERICAL
Definition: definitions.h:118
MoFEM::ForcesAndSourcesCore::UserDataOperator
friend class UserDataOperator
Definition: ForcesAndSourcesCore.hpp:482
field_name
constexpr auto field_name
Definition: poisson_2d_homogeneous.cpp:13
FTensor::Index
Definition: Index.hpp:23
CYLINDRICAL
@ CYLINDRICAL
Definition: definitions.h:117
MoFEM::OpCalculateDivergenceVectorFieldValues::dataPtr
boost::shared_ptr< VectorDouble > dataPtr
Definition: UserDataOperators.hpp:583
MOFEM_DATA_INCONSISTENCY
@ MOFEM_DATA_INCONSISTENCY
Definition: definitions.h:31
MoFEM::OpCalculateDivergenceVectorFieldValues::zeroType
const EntityHandle zeroType
Definition: UserDataOperators.hpp:584
MoFEMFunctionReturn
#define MoFEMFunctionReturn(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:416
MOFEM_NOT_IMPLEMENTED
@ MOFEM_NOT_IMPLEMENTED
Definition: definitions.h:32
MoFEMFunctionBegin
#define MoFEMFunctionBegin
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:346
MoFEM::ForcesAndSourcesCore::UserDataOperator::getFTensor1CoordsAtGaussPts
auto getFTensor1CoordsAtGaussPts()
Get coordinates at integration points assuming linear geometry.
Definition: ForcesAndSourcesCore.hpp:1268
MoFEM::ForcesAndSourcesCore::UserDataOperator::OPROW
@ OPROW
operator doWork function is executed on FE rows
Definition: ForcesAndSourcesCore.hpp:567
Generated by Doxygen 1.8.17 and hosted at University of Glasgow