base operator to do operations at Gauss Pt. level More...

#include <src/finite_elements/DataOperators.hpp>

Inheritance diagram for MoFEM::DataOperator:

Collaboration diagram for MoFEM::DataOperator:

Public Member Functions
	DataOperator (const bool symm=true)

virtual	~DataOperator ()=default

virtual MoFEMErrorCode	doWork (int row_side, int col_side, EntityType row_type, EntityType col_type, DataForcesAndSourcesCore::EntData &row_data, DataForcesAndSourcesCore::EntData &col_data)
	Operator for bi-linear form, usually to calculate values on left hand side. More...

virtual MoFEMErrorCode	opLhs (DataForcesAndSourcesCore &row_data, DataForcesAndSourcesCore &col_data)

virtual MoFEMErrorCode	doWork (int side, EntityType type, DataForcesAndSourcesCore::EntData &data)
	Operator for linear form, usually to calculate values on right hand side. More...

virtual MoFEMErrorCode	opRhs (DataForcesAndSourcesCore &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...

Public Attributes
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...

Private Member Functions
template<bool Symm>
MoFEMErrorCode	opLhs (DataForcesAndSourcesCore &row_data, DataForcesAndSourcesCore &col_data)

template<bool ErrorIfNoBase>
MoFEMErrorCode	opRhs (DataForcesAndSourcesCore &data, const std::array< bool, MBMAXTYPE > &do_entities)

Detailed Description

base operator to do operations at Gauss Pt. level

Definition at line 36 of file DataOperators.hpp.

Constructor & Destructor Documentation

◆ DataOperator()

MoFEM::DataOperator::DataOperator ( const bool symm = true )

Definition at line 33 of file DataOperators.cpp.

     :
 
       sYmm(symm),
 
       doEntities{true, true, true, true, true, true,
                  true, true, true, true, true, true},
 
       doVertices(doEntities[MBVERTEX]), doEdges(doEntities[MBEDGE]),
       doQuads(doEntities[MBQUAD]), doTris(doEntities[MBTRI]),
       doTets(doEntities[MBTET]), doPrisms(doEntities[MBPRISM]) {
 
   /// This not yet implemented, switch off.
   doEntities[MBPOLYGON] = false;
   doEntities[MBPYRAMID] = false;
   doEntities[MBKNIFE] = false;
   doEntities[MBHEX] = false;
   doEntities[MBPOLYHEDRON] = false;
 }

◆ ~DataOperator()

virtual MoFEM::DataOperator::~DataOperator ( )

virtualdefault

Member Function Documentation

◆ doWork() [1/2]

virtual MoFEMErrorCode MoFEM::DataOperator::doWork	(	int	row_side,
		int	col_side,
		EntityType	row_type,
		EntityType	col_type,
		DataForcesAndSourcesCore::EntData &	row_data,
		DataForcesAndSourcesCore::EntData &	col_data
	)

virtual

Operator for bi-linear form, usually to calculate values on left hand side.

Definition at line 45 of file DataOperators.hpp.

                                                                            {
     MoFEMFunctionBeginHot;
     SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
             "doWork function is not implemented for this operator");
     MoFEMFunctionReturnHot(0);
   }

◆ doWork() [2/2]

virtual MoFEMErrorCode MoFEM::DataOperator::doWork	(	int	side,
		EntityType	type,
		DataForcesAndSourcesCore::EntData &	data
	)

virtual

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

Definition at line 61 of file DataOperators.hpp.

                                                                        {
     MoFEMFunctionBeginHot;
     SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
             "doWork function is not implemented for this operator");
     MoFEMFunctionReturnHot(0);
   }

◆ getSymm()

bool MoFEM::DataOperator::getSymm ( ) const

Get if operator uses symmetry of DOFs or not.

If symmetry is used, only not repeating combinations of entities are looped. For an example pair of (Vertex, Edge_0) and (Edge_0, Vertex) will calculate the same matrices only transposed. Implementing that this can be exploited by integrating only one pair.

Returns: true if symmetry

Definition at line 97 of file DataOperators.hpp.

97 { return sYmm; }

MoFEM::DataOperator::sYmm

bool sYmm

If true assume that matrix is symmetric structure.

Definition: DataOperators.hpp:72

◆ opLhs() [1/2]

MoFEMErrorCode MoFEM::DataOperator::opLhs	(	DataForcesAndSourcesCore &	row_data,
		DataForcesAndSourcesCore &	col_data
	)

virtual

Definition at line 111 of file DataOperators.cpp.

                                                                        {
   if (getSymm())
     return opLhs<true>(row_data, col_data);
   else
     return opLhs<false>(row_data, col_data);
 }

◆ opLhs() [2/2]

template<bool Symm>

MoFEMErrorCode MoFEM::DataOperator::opLhs	(	DataForcesAndSourcesCore &	row_data,
		DataForcesAndSourcesCore &	col_data
	)

private

Definition at line 54 of file DataOperators.cpp.

                                                                        {
   MoFEMFunctionBeginHot;
 
   auto do_col_entity =
       [&](boost::ptr_vector<DataForcesAndSourcesCore::EntData> &row_ent_data,
           const int ss, const EntityType row_type, const EntityType low_type,
           const EntityType hi_type) {
         MoFEMFunctionBegin;
         for (EntityType col_type = low_type; col_type != hi_type; ++col_type) {
           auto &col_ent_data = col_data.dataOnEntities[col_type];
           for (size_t SS = 0; SS != col_ent_data.size(); SS++) {
             if (col_ent_data[SS].getFieldData().size())
               CHKERR doWork(ss, SS, row_type, col_type, row_ent_data[ss],
                             col_ent_data[SS]);
           }
         }
         MoFEMFunctionReturn(0);
       };
 
   auto do_row_entity = [&](const EntityType type) {
     MoFEMFunctionBegin;
     auto &row_ent_data = row_data.dataOnEntities[type];
     for (size_t ss = 0; ss != row_ent_data.size(); ++ss) {
       size_t SS = 0;
       if (Symm)
         SS = ss;
       for (; SS < col_data.dataOnEntities[type].size(); SS++) {
         CHKERR doWork(ss, SS, type, type, row_ent_data[ss],
                       col_data.dataOnEntities[type][SS]);
       }
       if (!Symm)
         CHKERR do_col_entity(row_ent_data, ss, type, MBVERTEX, type);
       CHKERR do_col_entity(row_ent_data, ss, type,
                            static_cast<EntityType>(type + 1), MBMAXTYPE);
     }
     MoFEMFunctionReturn(0);
   };
 
   for (EntityType row_type = MBVERTEX; row_type != MBENTITYSET; ++row_type) {
     if (doEntities[row_type]) {
       CHKERR do_row_entity(row_type);
     }
   }
 
   if (doEntities[MBENTITYSET]) {
     for (unsigned int mm = 0; mm != row_data.dataOnEntities[MBENTITYSET].size();
          ++mm) {
       if (!row_data.dataOnEntities[MBENTITYSET][mm].getFieldData().empty()) {
         CHKERR do_row_entity(MBENTITYSET);
       }
     }
   }
 
   MoFEMFunctionReturnHot(0);
 }

◆ opRhs() [1/2]

MoFEMErrorCode MoFEM::DataOperator::opRhs	(	DataForcesAndSourcesCore &	data,
		const bool	error_if_no_base = `false`
	)

virtual

Definition at line 171 of file DataOperators.cpp.

                                                                 {
   if (error_if_no_base)
     return opRhs<true>(data, doEntities);
   else
     return opRhs<false>(data, doEntities);
 }

◆ opRhs() [2/2]

template<bool ErrorIfNoBase>

MoFEMErrorCode MoFEM::DataOperator::opRhs	(	DataForcesAndSourcesCore &	data,
		const std::array< bool, MBMAXTYPE > &	do_entities
	)

private

Definition at line 121 of file DataOperators.cpp.

                                                                   {
   MoFEMFunctionBegin;
 
   auto do_entity = [&](auto type) {
     MoFEMFunctionBegin;
 
     auto &ent_data = data.dataOnEntities[type];
     const size_t size = ent_data.size();
     for (size_t ss = 0; ss != size; ++ss) {
 
       auto &side_data = ent_data[ss];
 
       if (ErrorIfNoBase) {
         if (side_data.getFieldData().size() &&
             (side_data.getBase() == NOBASE ||
              side_data.getBase() == LASTBASE)) {
           for (VectorDofs::iterator it = side_data.getFieldDofs().begin();
                it != side_data.getFieldDofs().end(); it++)
             if ((*it) && (*it)->getActive())
               SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "No base on");
         }
       }
 
       CHKERR doWork(ss, type, side_data);
     }
 
     MoFEMFunctionReturn(0);
   };
 
   for (EntityType row_type = MBVERTEX; row_type != MBENTITYSET; ++row_type) {
     if (do_entities[row_type]) {
       CHKERR do_entity(row_type);
     }
   }
 
   if (do_entities[MBENTITYSET]) {
     // This is odd behaviour, diffrent than for other entities. Should be
     // changed that behaviour is consistent,
     for (unsigned int mm = 0; mm != data.dataOnEntities[MBENTITYSET].size();
          ++mm) {
       if (!data.dataOnEntities[MBENTITYSET][mm].getFieldData().empty()) {
         CHKERR doWork(mm, MBENTITYSET, data.dataOnEntities[MBENTITYSET][mm]);
       }
     }
   }
 
   MoFEMFunctionReturn(0);
 }

◆ setSymm()

void MoFEM::DataOperator::setSymm ( )

set if operator is executed taking in account symmetry

Definition at line 100 of file DataOperators.hpp.

100 { sYmm = true; }

MoFEM::DataOperator::sYmm

bool sYmm

If true assume that matrix is symmetric structure.

Definition: DataOperators.hpp:72

◆ unSetSymm()

void MoFEM::DataOperator::unSetSymm ( )

unset if operator is executed for non symmetric problem

Definition at line 103 of file DataOperators.hpp.

103 { sYmm = false; }

MoFEM::DataOperator::sYmm

bool sYmm

If true assume that matrix is symmetric structure.

Definition: DataOperators.hpp:72

Member Data Documentation

◆ doEdges

bool& MoFEM::DataOperator::doEdges

\deprectaed If false skip edges

Examples: ElasticityMixedFormulation.hpp.

Definition at line 81 of file DataOperators.hpp.

◆ doEntities

std::array<bool, MBMAXTYPE> MoFEM::DataOperator::doEntities

If true operator is executed for entity.

Definition at line 75 of file DataOperators.hpp.

◆ doPrisms

bool& MoFEM::DataOperator::doPrisms

\deprectaed

Examples: ElasticityMixedFormulation.hpp.

Definition at line 85 of file DataOperators.hpp.

◆ doQuads

bool& MoFEM::DataOperator::doQuads

\deprectaed

Examples: ElasticityMixedFormulation.hpp.

Definition at line 82 of file DataOperators.hpp.

◆ doTets

bool& MoFEM::DataOperator::doTets

\deprectaed

Examples: ElasticityMixedFormulation.hpp.

Definition at line 84 of file DataOperators.hpp.

◆ doTris

bool& MoFEM::DataOperator::doTris

\deprectaed

Examples: ElasticityMixedFormulation.hpp.

Definition at line 83 of file DataOperators.hpp.

◆ doVertices

bool& MoFEM::DataOperator::doVertices

\deprectaed If false skip vertices

Examples: ElasticityMixedFormulation.hpp.

Definition at line 80 of file DataOperators.hpp.

◆ sYmm

bool MoFEM::DataOperator::sYmm

If true assume that matrix is symmetric structure.

Examples: heat_equation.hpp, MagneticElement.hpp, UnsaturatedFlow.hpp, and wave_equation.hpp.

Definition at line 72 of file DataOperators.hpp.

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

src/finite_elements/DataOperators.hpp
src/finite_elements/impl/DataOperators.cpp

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DataOperator()

◆ ~DataOperator()

Member Function Documentation

◆ doWork() [1/2]

◆ doWork() [2/2]

◆ getSymm()

◆ opLhs() [1/2]

◆ opLhs() [2/2]

◆ opRhs() [1/2]

◆ opRhs() [2/2]

◆ setSymm()

◆ unSetSymm()

Member Data Documentation

◆ doEdges

◆ doEntities

◆ doPrisms

◆ doQuads

◆ doTets

◆ doTris

◆ doVertices

◆ sYmm