MoFEM::OpBaseImpl< A, EleOp > Struct Template Reference

#include "src/finite_elements/FormsIntegrators.hpp"

Inheritance diagram for MoFEM::OpBaseImpl< A, EleOp >:

Collaboration diagram for MoFEM::OpBaseImpl< A, EleOp >:

Public Types
using	OpType = typename EleOp::OpType
using	EntData = EntitiesFieldData::EntData
using	MatSetValuesHook = boost::function< MoFEMErrorCode(ForcesAndSourcesCore::UserDataOperator *op_ptr, const EntitiesFieldData::EntData &row_data, const EntitiesFieldData::EntData &col_data, MatrixDouble &m)>

Public Member Functions
	OpBaseImpl (const std::string row_field_name, const std::string col_field_name, const OpType type, boost::shared_ptr< Range > ents_ptr=nullptr)
	Constructor for base operator implementation.
MoFEMErrorCode	doWork (int row_side, int col_side, EntityType row_type, EntityType col_type, EntData &row_data, EntData &col_data)
	Do calculations for the left hand side.
MoFEMErrorCode	doWork (int row_side, EntityType row_type, EntData &row_data)
	Do calculations for the right hand side.

Public Attributes
TimeFun	timeScalingFun
	assumes that time variable is set
FEFun	feScalingFun
	assumes that time variable is set
boost::shared_ptr< Range >	entsPtr
	Entities on which element is run.

Static Public Attributes
static MatSetValuesHook	matSetValuesHook

Protected Member Functions
template<int DIM>
FTensor::Tensor1< FTensor::PackPtr< double *, DIM >, DIM >	getNf ()
	Get local vector tensor for assembly.
template<int DIM>
FTensor::Tensor2< FTensor::PackPtr< double *, DIM >, DIM, DIM >	getLocMat (const int rr)
	Get local matrix tensor for assembly.
virtual MoFEMErrorCode	iNtegrate (EntData &row_data, EntData &col_data)
	Integrate grad-grad operator.
virtual MoFEMErrorCode	aSsemble (EntData &row_data, EntData &col_data, const bool trans)
	Assemble local matrix into global matrix.
virtual MoFEMErrorCode	iNtegrate (EntData &data)
	Class dedicated to integrate operator.
virtual MoFEMErrorCode	aSsemble (EntData &data)
	Assemble local vector into global vector.
virtual size_t	getNbOfBaseFunctions (EntitiesFieldData::EntData &data)
	Get number of base functions.

Protected Attributes
int	nbRows
	number of dofs on rows
int	nbCols
	number if dof on column
int	nbIntegrationPts
	number of integration points
int	nbRowBaseFunctions
	number or row base functions
int	rowSide
	row side number
int	colSide
	column side number
EntityType	rowType
	row type
EntityType	colType
	column type
bool	assembleTranspose
bool	onlyTranspose
MatrixDouble	locMat
	local entity block matrix
MatrixDouble	locMatTranspose
	local entity block matrix
VectorDouble	locF
	local entity vector

Detailed Description

template<AssemblyType A, typename EleOp>
struct MoFEM::OpBaseImpl< A, EleOp >

Examples

mofem/atom_tests/schur_test_diag_mat.cpp, mofem/tutorials/adv-2/src/ThermoElasticOps.hpp, mofem/tutorials/adv-2/thermo_elastic.cpp, and mofem/tutorials/scl-8/radiation.cpp.

Definition at line 292 of file FormsIntegrators.hpp.

Member Typedef Documentation

EntData

template<AssemblyType A, typename EleOp >

using MoFEM::OpBaseImpl< A, EleOp >::EntData = EntitiesFieldData::EntData

Definition at line 294 of file FormsIntegrators.hpp.

MatSetValuesHook

template<AssemblyType A, typename EleOp >

using MoFEM::OpBaseImpl< A, EleOp >::MatSetValuesHook = boost::function<MoFEMErrorCode( ForcesAndSourcesCore::UserDataOperator *op_ptr, const EntitiesFieldData::EntData &row_data, const EntitiesFieldData::EntData &col_data, MatrixDouble &m)>

Definition at line 336 of file FormsIntegrators.hpp.

OpType

template<AssemblyType A, typename EleOp >

using MoFEM::OpBaseImpl< A, EleOp >::OpType = typename EleOp::OpType

Definition at line 293 of file FormsIntegrators.hpp.

Constructor & Destructor Documentation

OpBaseImpl()

template<AssemblyType A, typename EleOp >

MoFEM::OpBaseImpl< A, EleOp >::OpBaseImpl ( const std::string  row_field_name, const std::string  col_field_name, const OpType  type, boost::shared_ptr< Range >  ents_ptr = nullptr  )

inline

Constructor for base operator implementation.

Parameters

row_field_name	Name of field for row entities
col_field_name	Name of field for column entities
type	Operator type
ents_ptr	Optional pointer to range of entities to operate on

Definition at line 303 of file FormsIntegrators.hpp.

      : EleOp(row_field_name, col_field_name, type, false),
        assembleTranspose(false), onlyTranspose(false), entsPtr(ents_ptr) {}

Member Function Documentation

aSsemble() [1/2]

template<AssemblyType A, typename EleOp >

MoFEMErrorCode OpBaseImpl::aSsemble ( EntData &  data )

protectedvirtual

Assemble local vector into global vector.

Parameters

data	Entity data

Returns

Error code

Definition at line 648 of file FormsIntegrators.hpp.

                                                           {
  if (!this->timeScalingFun.empty())
    this->locF *= this->timeScalingFun(this->getFEMethod()->ts_t);
  if (!this->feScalingFun.empty())
    this->locF *= this->feScalingFun(this->getFEMethod());
 
  return VecSetValues<AssemblyTypeSelector<A>>(this->getKSPf(), data,
                                               this->locF, ADD_VALUES);
}

aSsemble() [2/2]

template<AssemblyType A, typename EleOp >

MoFEMErrorCode OpBaseImpl::aSsemble ( EntData &  row_data, EntData &  col_data, const bool  trans  )

protectedvirtual

Assemble local matrix into global matrix.

Parameters

row_data	Row entity data
col_data	Column entity data
trans	Whether to assemble transpose

Returns

Error code

Definition at line 621 of file FormsIntegrators.hpp.

                                                                    {
  MoFEMFunctionBegin;
 
  if (!this->timeScalingFun.empty())
    this->locMat *= this->timeScalingFun(this->getFEMethod()->ts_t);
  if (!this->feScalingFun.empty())
    this->locMat *= this->feScalingFun(this->getFEMethod());
 
  // Assemble transpose
  if (transpose) {
    this->locMatTranspose.resize(this->locMat.size2(), this->locMat.size1(),
                                 false);
    noalias(this->locMatTranspose) = trans(this->locMat);
    CHKERR matSetValuesHook(this, col_data, row_data, this->locMatTranspose);
  }
 
  if (!this->onlyTranspose) {
    // assemble local matrix
    CHKERR matSetValuesHook(this, row_data, col_data, this->locMat);
  }
 
  MoFEMFunctionReturn(0);
}

doWork() [1/2]

template<AssemblyType A, typename EleOp >

MoFEMErrorCode OpBaseImpl::doWork	(	int	row_side,
		EntityType	row_type,
		EntData &	row_data
	)

Do calculations for the right hand side.

Parameters

row_side
row_type
row_data

Returns

MoFEMErrorCode

Definition at line 590 of file FormsIntegrators.hpp.

                                                               {
  MoFEMFunctionBegin;
 
  if (entsPtr) {
    if (entsPtr->find(this->getFEEntityHandle()) == entsPtr->end())
      MoFEMFunctionReturnHot(0);
  }
 
  // get number of dofs on row
  nbRows = row_data.getIndices().size();
  rowSide = row_side;
  rowType = row_type;
 
  if (!nbRows)
    MoFEMFunctionReturnHot(0);
  // get number of integration points
  nbIntegrationPts = EleOp::getGaussPts().size2();
  // get row base functions
  nbRowBaseFunctions = getNbOfBaseFunctions(row_data);
  // resize and clear the right hand side vector
  locF.resize(nbRows);
  locF.clear();
  // integrate local vector
  CHKERR this->iNtegrate(row_data);
  // assemble local vector
  CHKERR this->aSsemble(row_data);
  MoFEMFunctionReturn(0);
}

doWork() [2/2]

template<AssemblyType A, typename EleOp >

MoFEMErrorCode OpBaseImpl::doWork	(	int	row_side,
		int	col_side,
		EntityType	row_type,
		EntityType	col_type,
		EntitiesFieldData::EntData &	row_data,
		EntitiesFieldData::EntData &	col_data
	)

Do calculations for the left hand side.

Parameters

row_side	row side number (local number) of entity on element
col_side	column side number (local number) of entity on element
row_type	type of row entity
col_type	type of column entity
row_data	data for row
col_data	data for column

Returns

error code

Definition at line 535 of file FormsIntegrators.hpp.

                                                                 {
  MoFEMFunctionBegin;
 
  if (entsPtr) {
    if (entsPtr->find(this->getFEEntityHandle()) == entsPtr->end())
      MoFEMFunctionReturnHot(0);
  }
 
  // get number of dofs on row
  nbRows = row_data.getIndices().size();
  // if no dofs on row, exit that work, nothing to do here
  if (!nbRows)
    MoFEMFunctionReturnHot(0);
  rowSide = row_side;
  rowType = row_type;
  // get number of dofs on column
  nbCols = col_data.getIndices().size();
  // if no dofs on column, exit nothing to do here
  if (!nbCols)
    MoFEMFunctionReturnHot(0);
  colSide = col_side;
  colType = col_type;
  // get number of integration points
  nbIntegrationPts = EleOp::getGaussPts().size2();
  // get row base functions
  nbRowBaseFunctions = getNbOfBaseFunctions(row_data);
 
  // set size of local entity bock
  locMat.resize(nbRows, nbCols, false);
  // clear matrix
  locMat.clear();
  // integrate local matrix for entity block
  CHKERR this->iNtegrate(row_data, col_data);
 
  // assemble local matrix
  auto check_if_assemble_transpose = [&] {
    if (this->sYmm) {
      if (row_side != col_side || row_type != col_type)
        return true;
      else
        return false;
    } else if (assembleTranspose) {
      return true;
    }
 
    return false;
  };
  CHKERR aSsemble(row_data, col_data, check_if_assemble_transpose());
  MoFEMFunctionReturn(0);
}

getLocMat()

template<AssemblyType A, typename EleOp >

template<int DIM>

FTensor::Tensor2< FTensor::PackPtr< double *, DIM >, DIM, DIM > MoFEM::OpBaseImpl< A, EleOp >::getLocMat ( const int  rr )

inlineprotected

Get local matrix tensor for assembly.

Template Parameters

DIM	Dimension of the tensor

Parameters

rr	Row offset in the local matrix

Returns

FTensor wrapper around local matrix

Definition at line 364 of file FormsIntegrators.hpp.

                          {
    return getFTensor2FromArray<DIM, DIM, DIM>(locMat, rr);
  }

getNbOfBaseFunctions()

template<AssemblyType A, typename EleOp >

size_t OpBaseImpl::getNbOfBaseFunctions ( EntitiesFieldData::EntData &  data )

protectedvirtual

Get number of base functions.

Parameters

data

Returns

number of base functions

Definition at line 495 of file FormsIntegrators.hpp.

                                                                         {
  if (!data.getNSharedPtr(data.getBase())) {
  #ifndef NDEBUG
    MOFEM_LOG("SELF", Sev::warning)
        << "Ptr to base " << ApproximationBaseNames[data.getBase()]
        << " functions is null, returning 0";
  #endif // NDEBUG
    return 0;
  }
  auto nb_base_functions = data.getN().size2();
  if (data.getBase() != USER_BASE) {
    switch (data.getSpace()) {
    case NOSPACE:
      break;
    case NOFIELD:
      break;
    case H1:
      break;
    case HCURL:
    case HDIV:
      nb_base_functions /= 3;
#ifndef NDEBUG
      if (data.getN().size2() % 3) {
        SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY,
                "Number of base functions is not divisible by 3");
      }
#endif
      break;
    case L2:
      break;
    default:
      SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
               "Space %s not implemented", FieldSpaceNames[data.getSpace()]);
    }
  }
  return nb_base_functions;
}

getNf()

template<AssemblyType A, typename EleOp >

template<int DIM>

FTensor::Tensor1< FTensor::PackPtr< double *, DIM >, DIM > MoFEM::OpBaseImpl< A, EleOp >::getNf ( )

inlineprotected

Get local vector tensor for assembly.

Template Parameters

DIM	Dimension of the tensor

Returns

FTensor wrapper around local vector

Definition at line 352 of file FormsIntegrators.hpp.

                                                                    {
    return getFTensor1FromArray<DIM, DIM>(locF);
  }

iNtegrate() [1/2]

template<AssemblyType A, typename EleOp >

virtual MoFEMErrorCode MoFEM::OpBaseImpl< A, EleOp >::iNtegrate ( EntData &  data )

inlineprotectedvirtual

Class dedicated to integrate operator.

Parameters

data	entity data on element row

Returns

error code

Reimplemented in Example::OpRadiationRhs, Example::OpFluxRhs, MoFEM::OpSourceImpl< 1, 1, GAUSS, SourceFunctionSpecialization::S< OpBase > >, MoFEM::OpSourceImpl< 1, FIELD_DIM, GAUSS, SourceFunctionSpecialization::S< OpBase > >, MoFEM::OpSourceImpl< 3, FIELD_DIM, GAUSS, SourceFunctionSpecialization::S< OpBase > >, MoFEM::OpBaseTimesScalarImpl< 1, S, GAUSS, OpBase >, MoFEM::OpBaseTimesVectorImpl< 1, FIELD_DIM, S, GAUSS, OpBase >, MoFEM::OpBaseTimesVectorImpl< 3, FIELD_DIM, S, GAUSS, OpBase >, MoFEM::OpGradTimesTensorImpl< 1, 1, SPACE_DIM, S, GAUSS, OpBase >, MoFEM::OpGradTimesTensorImpl< 1, SPACE_DIM, SPACE_DIM, S, GAUSS, OpBase >, MoFEM::OpGradTimesSymTensorImpl< 1, SPACE_DIM, SPACE_DIM, S, GAUSS, OpBase >, MoFEM::OpMixDivTimesUImpl< 3, FIELD_DIM, SPACE_DIM, GAUSS, OpBase, CoordSys >, MoFEM::OpMixDivTimesUImpl< 3, 1, SPACE_DIM, GAUSS, OpBase, CoordSys >, MoFEM::OpMixDivTimesUImpl< 1, FIELD_DIM, FIELD_DIM, GAUSS, OpBase, CoordSys >, MoFEM::OpMixVecTimesDivLambdaImpl< SPACE_DIM, GAUSS, OpBase >, MoFEM::OpMixTensorTimesGradUImpl< SPACE_DIM, GAUSS, OpBase >, MoFEM::OpNormalMixVecTimesScalarImpl< 3, GAUSS, OpBase >, MoFEM::OpNormalMixVecTimesScalarImpl< 2, GAUSS, OpBase >, MoFEM::OpNormalMixVecTimesVectorFieldImpl< SPACE_DIM, GAUSS, OpBase >, MoFEM::OpConvectiveTermRhsImpl< 1, 1, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpConvectiveTermRhsImpl< 1, FIELD_DIM, SPACE_DIM, GAUSS, OpBase >, and MoFEM::OpBrokenSpaceConstrainDHybridImpl< FIELD_DIM, GAUSS, OpBase >.

Definition at line 410 of file FormsIntegrators.hpp.

                                                  {
    return MOFEM_NOT_IMPLEMENTED;
  }

iNtegrate() [2/2]

template<AssemblyType A, typename EleOp >

virtual MoFEMErrorCode MoFEM::OpBaseImpl< A, EleOp >::iNtegrate ( EntData &  row_data, EntData &  col_data  )

inlineprotectedvirtual

Integrate grad-grad operator.

Parameters

row_data	row data (consist base functions on row entity)
col_data	column data (consist base functions on column entity)

Returns

error code

Reimplemented in Example::OpRadiationLhs, MoFEM::OpGradGradImpl< 1, 1, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpGradGradImpl< 1, FIELD_DIM, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpMassImpl< 1, 1, GAUSS, OpBase >, MoFEM::OpMassImpl< 1, FIELD_DIM, GAUSS, OpBase >, MoFEM::OpMassImpl< 3, FIELD_DIM, GAUSS, OpBase >, MoFEM::OpMassImpl< 3, 4, GAUSS, OpBase >, MoFEM::OpMassImpl< 3, 9, GAUSS, OpBase >, MoFEM::OpGradSymTensorGradImpl< 1, SPACE_DIM, SPACE_DIM, S, GAUSS, OpBase >, MoFEM::OpGradTensorGradImpl< 1, SPACE_DIM, SPACE_DIM, S, GAUSS, OpBase >, MoFEM::OpGradGradSymTensorGradGradImpl< 1, 1, SPACE_DIM, S, GAUSS, OpBase >, MoFEM::OpMixDivTimesScalarImpl< SPACE_DIM, GAUSS, OpBase >, MoFEM::OpMixDivTimesVecImpl< SPACE_DIM, GAUSS, OpBase, CoordSys >, MoFEM::OpMixScalarTimesDivImpl< SPACE_DIM, GAUSS, OpBase, COORDINATE_SYSTEM >, MoFEM::OpMixVectorTimesGradImpl< 3, SPACE_DIM, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpMixVectorTimesGradImpl< 1, SPACE_DIM, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpMixTensorTimesGradImpl< SPACE_DIM, GAUSS, OpBase >, MoFEM::OpConvectiveTermLhsDuImpl< 1, 1, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpConvectiveTermLhsDyImpl< 1, 1, SPACE_DIM, GAUSS, OpBase >, MoFEM::OpConvectiveTermLhsDuImpl< 1, FIELD_DIM, SPACE_DIM, GAUSS, OpBase >, and MoFEM::OpConvectiveTermLhsDyImpl< 1, FIELD_DIM, SPACE_DIM, GAUSS, OpBase >.

Definition at line 391 of file FormsIntegrators.hpp.

                                                                         {
    return MOFEM_NOT_IMPLEMENTED;
  }

Member Data Documentation

assembleTranspose

template<AssemblyType A, typename EleOp >

bool MoFEM::OpBaseImpl< A, EleOp >::assembleTranspose

protected

Definition at line 378 of file FormsIntegrators.hpp.

colSide

template<AssemblyType A, typename EleOp >

int MoFEM::OpBaseImpl< A, EleOp >::colSide

protected

column side number

Definition at line 374 of file FormsIntegrators.hpp.

colType

template<AssemblyType A, typename EleOp >

EntityType MoFEM::OpBaseImpl< A, EleOp >::colType

protected

column type

Definition at line 376 of file FormsIntegrators.hpp.

entsPtr

template<AssemblyType A, typename EleOp >

boost::shared_ptr<Range> MoFEM::OpBaseImpl< A, EleOp >::entsPtr

Entities on which element is run.

Definition at line 334 of file FormsIntegrators.hpp.

feScalingFun

template<AssemblyType A, typename EleOp >

FEFun MoFEM::OpBaseImpl< A, EleOp >::feScalingFun

assumes that time variable is set

Definition at line 333 of file FormsIntegrators.hpp.

locF

template<AssemblyType A, typename EleOp >

VectorDouble MoFEM::OpBaseImpl< A, EleOp >::locF

protected

local entity vector

Definition at line 383 of file FormsIntegrators.hpp.

locMat

template<AssemblyType A, typename EleOp >

MatrixDouble MoFEM::OpBaseImpl< A, EleOp >::locMat

protected

local entity block matrix

Examples

mofem/tutorials/scl-8/radiation.cpp.

Definition at line 381 of file FormsIntegrators.hpp.

locMatTranspose

template<AssemblyType A, typename EleOp >

MatrixDouble MoFEM::OpBaseImpl< A, EleOp >::locMatTranspose

protected

local entity block matrix

Definition at line 382 of file FormsIntegrators.hpp.

matSetValuesHook

template<AssemblyType A, typename EleOp >

OpBaseImpl< A, EleOp >::MatSetValuesHook OpBaseImpl::matSetValuesHook

static

Initial value:

=
        [](ForcesAndSourcesCore::UserDataOperator *op_ptr,
           const EntitiesFieldData::EntData &row_data,
           const EntitiesFieldData::EntData &col_data, MatrixDouble &m) {
          return MatSetValues<AssemblyTypeSelector<A>>(
              op_ptr->getKSPB(), row_data, col_data, m, ADD_VALUES);
        }

Definition at line 341 of file FormsIntegrators.hpp.

nbCols

template<AssemblyType A, typename EleOp >

int MoFEM::OpBaseImpl< A, EleOp >::nbCols

protected

number if dof on column

Examples

mofem/tutorials/scl-8/radiation.cpp.

Definition at line 369 of file FormsIntegrators.hpp.

nbIntegrationPts

template<AssemblyType A, typename EleOp >

int MoFEM::OpBaseImpl< A, EleOp >::nbIntegrationPts

protected

number of integration points

Examples

mofem/tutorials/scl-8/radiation.cpp.

Definition at line 370 of file FormsIntegrators.hpp.

nbRowBaseFunctions

template<AssemblyType A, typename EleOp >

int MoFEM::OpBaseImpl< A, EleOp >::nbRowBaseFunctions

protected

number or row base functions

Definition at line 371 of file FormsIntegrators.hpp.

nbRows

template<AssemblyType A, typename EleOp >

int MoFEM::OpBaseImpl< A, EleOp >::nbRows

protected

number of dofs on rows

Examples

mofem/tutorials/scl-8/radiation.cpp.

Definition at line 368 of file FormsIntegrators.hpp.

onlyTranspose

template<AssemblyType A, typename EleOp >

bool MoFEM::OpBaseImpl< A, EleOp >::onlyTranspose

protected

Definition at line 379 of file FormsIntegrators.hpp.

rowSide

template<AssemblyType A, typename EleOp >

int MoFEM::OpBaseImpl< A, EleOp >::rowSide

protected

row side number

Definition at line 373 of file FormsIntegrators.hpp.

rowType

template<AssemblyType A, typename EleOp >

EntityType MoFEM::OpBaseImpl< A, EleOp >::rowType

protected

row type

Definition at line 375 of file FormsIntegrators.hpp.

timeScalingFun

template<AssemblyType A, typename EleOp >

TimeFun MoFEM::OpBaseImpl< A, EleOp >::timeScalingFun

assumes that time variable is set

Definition at line 332 of file FormsIntegrators.hpp.

---

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

• src/finite_elements/FormsIntegrators.hpp