GenericElementInterface Struct Reference

Set of functions declaring elements and setting operators for generic element interface. More...

#include "tutorials/src/GenericElementInterface.hpp"

Inheritance diagram for GenericElementInterface:

Collaboration diagram for GenericElementInterface:

Public Types
enum	TSType {   EX , IM , IM2 , IMEX ,   DEFAULT , EX , IM , IM2 ,   IMEX , DEFAULT }
enum	TSType {   EX , IM , IM2 , IMEX ,   DEFAULT , EX , IM , IM2 ,   IMEX , DEFAULT }
using	BcMarkerPtr = boost::shared_ptr<std::vector<char unsigned>>

Public Member Functions
	GenericElementInterface ()
virtual	~GenericElementInterface ()
virtual MoFEMErrorCode	setGlobalBoundaryMarker (BcMarkerPtr mark)
virtual BcMarkerPtr	getGlobalBoundaryMarker ()
virtual MoFEMErrorCode	setMonitorPtr (boost::shared_ptr< MoFEM::FEMethod > monitor_ptr)
virtual MoFEMErrorCode	getCommandLineParameters ()
virtual MoFEMErrorCode	addElementFields ()=0
virtual MoFEMErrorCode	createElements ()=0
virtual MoFEMErrorCode	addElementsToDM (SmartPetscObj< DM > dm)=0
virtual BitRefLevel	getBitRefLevel ()
virtual BitRefLevel	getBitRefLevelMask ()
virtual MoFEMErrorCode	setOperators ()=0
virtual MoFEMErrorCode	opFactoryDomainRhs (boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > &pip)
virtual MoFEMErrorCode	opFactoryDomainLhs (boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > &pip)
virtual MoFEMErrorCode	setUpdateElementVariablesOperators ()
virtual MoFEMErrorCode	setupSolverJacobianSNES ()
virtual MoFEMErrorCode	setupSolverFunctionSNES ()
virtual MoFEMErrorCode	setupSolverJacobianTS (const TSType type)=0
virtual MoFEMErrorCode	setupSolverFunctionTS (const TSType type)=0
virtual MoFEMErrorCode	updateElementVariables ()
virtual MoFEMErrorCode	updateElementVariables (SmartPetscObj< DM > dm, string fe_name)
virtual MoFEMErrorCode	postProcessElement (int step)=0
virtual MoFEMErrorCode	postProcessElement (int step, SmartPetscObj< DM > dm, string fe_name)
	GenericElementInterface ()
virtual	~GenericElementInterface ()
virtual MoFEMErrorCode	setGlobalBoundaryMarker (BcMarkerPtr mark)
virtual BcMarkerPtr	getGlobalBoundaryMarker ()
virtual MoFEMErrorCode	setMonitorPtr (boost::shared_ptr< FEMethod > monitor_ptr)
virtual MoFEMErrorCode	getCommandLineParameters ()
virtual MoFEMErrorCode	addElementFields ()=0
virtual MoFEMErrorCode	createElements ()=0
virtual MoFEMErrorCode	addElementsToDM (SmartPetscObj< DM > dm)=0
virtual BitRefLevel	getBitRefLevel ()
virtual BitRefLevel	getBitRefLevelMask ()
virtual MoFEMErrorCode	setOperators ()=0
virtual MoFEMErrorCode	opFactoryDomainRhs (boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > &pip)
virtual MoFEMErrorCode	opFactoryDomainLhs (boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > &pip)
virtual MoFEMErrorCode	setUpdateElementVariablesOperators ()
virtual MoFEMErrorCode	setupSolverJacobianSNES ()
virtual MoFEMErrorCode	setupSolverFunctionSNES ()
virtual MoFEMErrorCode	setupSolverJacobianTS (const TSType type)=0
virtual MoFEMErrorCode	setupSolverFunctionTS (const TSType type)=0
virtual MoFEMErrorCode	updateElementVariables ()
virtual MoFEMErrorCode	updateElementVariables (SmartPetscObj< DM > dm, string fe_name)
virtual MoFEMErrorCode	postProcessElement (int step)=0
virtual MoFEMErrorCode	postProcessElement (int step, SmartPetscObj< DM > dm, string fe_name)

Public Attributes
BcMarkerPtr	mBoundaryMarker
int	atomTest
int	restartRunStep
boost::shared_ptr< MoFEM::FEMethod >	monitorPtr
boost::shared_ptr< FEMethod >	monitorPtr

Detailed Description

Set of functions declaring elements and setting operators for generic element interface.

Examples

NonlinearElasticElementInterface.hpp.

Definition at line 13 of file GenericElementInterface.hpp.

Member Typedef Documentation

BcMarkerPtr

using GenericElementInterface::BcMarkerPtr = boost::shared_ptr<std::vector<char unsigned>>

Definition at line 17 of file GenericElementInterface.hpp.

Member Enumeration Documentation

TSType [1/2]

enum GenericElementInterface::TSType

Enumerator
EX
IM
IM2
IMEX
DEFAULT
EX
IM
IM2
IMEX
DEFAULT

Examples

NonlinearElasticElementInterface.hpp.

Definition at line 16 of file GenericElementInterface.hpp.

{ EX, IM, IM2, IMEX, DEFAULT };

TSType [2/2]

enum GenericElementInterface::TSType

Enumerator
EX
IM
IM2
IMEX
DEFAULT
EX
IM
IM2
IMEX
DEFAULT

Definition at line 16 of file GenericElementInterface.hpp.

{ EX, IM, IM2, IMEX, DEFAULT };

Constructor & Destructor Documentation

GenericElementInterface() [1/2]

GenericElementInterface::GenericElementInterface ( )

inline

Definition at line 31 of file GenericElementInterface.hpp.

{}

~GenericElementInterface() [1/2]

virtual GenericElementInterface::~GenericElementInterface ( )

inlinevirtual

Definition at line 32 of file GenericElementInterface.hpp.

{}

GenericElementInterface() [2/2]

GenericElementInterface::GenericElementInterface ( )

inline

Definition at line 31 of file GenericElementInterface.hpp.

{}

~GenericElementInterface() [2/2]

virtual GenericElementInterface::~GenericElementInterface ( )

inlinevirtual

Definition at line 32 of file GenericElementInterface.hpp.

{}

Member Function Documentation

addElementFields() [1/2]

virtual MoFEMErrorCode GenericElementInterface::addElementFields ( )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

addElementFields() [2/2]

virtual MoFEMErrorCode GenericElementInterface::addElementFields ( )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

addElementsToDM() [1/2]

virtual MoFEMErrorCode GenericElementInterface::addElementsToDM ( SmartPetscObj< DM > dm )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

addElementsToDM() [2/2]

virtual MoFEMErrorCode GenericElementInterface::addElementsToDM ( SmartPetscObj< DM > dm )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

createElements() [1/2]

virtual MoFEMErrorCode GenericElementInterface::createElements ( )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

createElements() [2/2]

virtual MoFEMErrorCode GenericElementInterface::createElements ( )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

getBitRefLevel() [1/2]

virtual BitRefLevel GenericElementInterface::getBitRefLevel ( )

inlinevirtual

Reimplemented in NonlinearElasticElementInterface.

Definition at line 55 of file GenericElementInterface.hpp.

{ return BitRefLevel().set(); };

getBitRefLevel() [2/2]

virtual BitRefLevel GenericElementInterface::getBitRefLevel ( )

inlinevirtual

Reimplemented in NonlinearElasticElementInterface.

Definition at line 55 of file GenericElementInterface.hpp.

{ return BitRefLevel().set(); };

getBitRefLevelMask() [1/2]

virtual BitRefLevel GenericElementInterface::getBitRefLevelMask ( )

inlinevirtual

Definition at line 56 of file GenericElementInterface.hpp.

{ return BitRefLevel().set(); };

getBitRefLevelMask() [2/2]

virtual BitRefLevel GenericElementInterface::getBitRefLevelMask ( )

inlinevirtual

Definition at line 56 of file GenericElementInterface.hpp.

{ return BitRefLevel().set(); };

getCommandLineParameters() [1/2]

virtual MoFEMErrorCode GenericElementInterface::getCommandLineParameters ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 49 of file GenericElementInterface.hpp.

{ return 0; };

getCommandLineParameters() [2/2]

virtual MoFEMErrorCode GenericElementInterface::getCommandLineParameters ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 49 of file GenericElementInterface.hpp.

{ return 0; };

getGlobalBoundaryMarker() [1/2]

virtual BcMarkerPtr GenericElementInterface::getGlobalBoundaryMarker ( )

inlinevirtual

Definition at line 40 of file GenericElementInterface.hpp.

{ return mBoundaryMarker; };

getGlobalBoundaryMarker() [2/2]

virtual BcMarkerPtr GenericElementInterface::getGlobalBoundaryMarker ( )

inlinevirtual

Definition at line 40 of file GenericElementInterface.hpp.

{ return mBoundaryMarker; };

opFactoryDomainLhs() [1/2]

virtual MoFEMErrorCode GenericElementInterface::opFactoryDomainLhs ( boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > & pip )

inlinevirtual

Definition at line 65 of file GenericElementInterface.hpp.

                                                                 {
    return 0;
  };

opFactoryDomainLhs() [2/2]

virtual MoFEMErrorCode GenericElementInterface::opFactoryDomainLhs ( boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > & pip )

inlinevirtual

Definition at line 65 of file GenericElementInterface.hpp.

                                                                 {
    return 0;
  };

opFactoryDomainRhs() [1/2]

virtual MoFEMErrorCode GenericElementInterface::opFactoryDomainRhs ( boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > & pip )

inlinevirtual

Definition at line 61 of file GenericElementInterface.hpp.

                                                                 {
    return 0;
  };

opFactoryDomainRhs() [2/2]

virtual MoFEMErrorCode GenericElementInterface::opFactoryDomainRhs ( boost::ptr_deque< ForcesAndSourcesCore::UserDataOperator > & pip )

inlinevirtual

Definition at line 61 of file GenericElementInterface.hpp.

                                                                 {
    return 0;
  };

postProcessElement() [1/4]

virtual MoFEMErrorCode GenericElementInterface::postProcessElement ( int step )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

postProcessElement() [2/4]

virtual MoFEMErrorCode GenericElementInterface::postProcessElement ( int step )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

postProcessElement() [3/4]

virtual MoFEMErrorCode GenericElementInterface::postProcessElement ( int step, SmartPetscObj< DM > dm, string fe_name )

inlinevirtual

Definition at line 98 of file GenericElementInterface.hpp.

                                                            {
    return 0;
  };

postProcessElement() [4/4]

virtual MoFEMErrorCode GenericElementInterface::postProcessElement ( int step, SmartPetscObj< DM > dm, string fe_name )

inlinevirtual

Definition at line 98 of file GenericElementInterface.hpp.

                                                            {
    return 0;
  };

setGlobalBoundaryMarker() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setGlobalBoundaryMarker ( BcMarkerPtr mark )

inlinevirtual

Definition at line 34 of file GenericElementInterface.hpp.

                                                                   {
    MoFEMFunctionBeginHot;
    mBoundaryMarker = mark;
    MoFEMFunctionReturnHot(0);
  }

setGlobalBoundaryMarker() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setGlobalBoundaryMarker ( BcMarkerPtr mark )

inlinevirtual

Definition at line 34 of file GenericElementInterface.hpp.

                                                                   {
    MoFEMFunctionBeginHot;
    mBoundaryMarker = mark;
    MoFEMFunctionReturnHot(0);
  }

setMonitorPtr() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setMonitorPtr ( boost::shared_ptr< FEMethod > monitor_ptr )

inlinevirtual

Definition at line 42 of file GenericElementInterface.hpp.

                                                                              {
    MoFEMFunctionBeginHot;
    monitorPtr = monitor_ptr;
    MoFEMFunctionReturnHot(0);
  }

setMonitorPtr() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setMonitorPtr ( boost::shared_ptr< MoFEM::FEMethod > monitor_ptr )

inlinevirtual

Definition at line 42 of file GenericElementInterface.hpp.

                                                                                   {
    MoFEMFunctionBeginHot;
    monitorPtr = monitor_ptr;
    MoFEMFunctionReturnHot(0);
  }

setOperators() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setOperators ( )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

setOperators() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setOperators ( )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

setUpdateElementVariablesOperators() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setUpdateElementVariablesOperators ( )

inlinevirtual

Definition at line 70 of file GenericElementInterface.hpp.

{ return 0; };

setUpdateElementVariablesOperators() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setUpdateElementVariablesOperators ( )

inlinevirtual

Definition at line 70 of file GenericElementInterface.hpp.

{ return 0; };

setupSolverFunctionSNES() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverFunctionSNES ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 80 of file GenericElementInterface.hpp.

                                                   {
    MoFEMFunctionBeginHot;
    SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED, "SNES not implemented");
    MoFEMFunctionReturnHot(0);
  };

setupSolverFunctionSNES() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverFunctionSNES ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 80 of file GenericElementInterface.hpp.

                                                   {
    MoFEMFunctionBeginHot;
    SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED, "SNES not implemented");
    MoFEMFunctionReturnHot(0);
  };

setupSolverFunctionTS() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverFunctionTS ( const TSType type )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

setupSolverFunctionTS() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverFunctionTS ( const TSType type )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

setupSolverJacobianSNES() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverJacobianSNES ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 74 of file GenericElementInterface.hpp.

                                                   {
    MoFEMFunctionBeginHot;
    SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED, "SNES not implemented");
    MoFEMFunctionReturnHot(0);
  };

setupSolverJacobianSNES() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverJacobianSNES ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 74 of file GenericElementInterface.hpp.

                                                   {
    MoFEMFunctionBeginHot;
    SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED, "SNES not implemented");
    MoFEMFunctionReturnHot(0);
  };

setupSolverJacobianTS() [1/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverJacobianTS ( const TSType type )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

setupSolverJacobianTS() [2/2]

virtual MoFEMErrorCode GenericElementInterface::setupSolverJacobianTS ( const TSType type )

pure virtual

Implemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

updateElementVariables() [1/4]

virtual MoFEMErrorCode GenericElementInterface::updateElementVariables ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 90 of file GenericElementInterface.hpp.

{ return 0; };

updateElementVariables() [2/4]

virtual MoFEMErrorCode GenericElementInterface::updateElementVariables ( )

inlinevirtual

Reimplemented in BasicBoundaryConditionsInterface, and NonlinearElasticElementInterface.

Definition at line 90 of file GenericElementInterface.hpp.

{ return 0; };

updateElementVariables() [3/4]

virtual MoFEMErrorCode GenericElementInterface::updateElementVariables ( SmartPetscObj< DM > dm, string fe_name )

inlinevirtual

Definition at line 91 of file GenericElementInterface.hpp.

                                                                {
    return 0;
  };

updateElementVariables() [4/4]

virtual MoFEMErrorCode GenericElementInterface::updateElementVariables ( SmartPetscObj< DM > dm, string fe_name )

inlinevirtual

Definition at line 91 of file GenericElementInterface.hpp.

                                                                {
    return 0;
  };

Member Data Documentation

atomTest

int GenericElementInterface::atomTest

Definition at line 21 of file GenericElementInterface.hpp.

mBoundaryMarker

BcMarkerPtr GenericElementInterface::mBoundaryMarker

Examples

NonlinearElasticElementInterface.hpp.

Definition at line 20 of file GenericElementInterface.hpp.

monitorPtr [1/2]

boost::shared_ptr<MoFEM::FEMethod> GenericElementInterface::monitorPtr

Definition at line 24 of file GenericElementInterface.hpp.

monitorPtr [2/2]

boost::shared_ptr<FEMethod> GenericElementInterface::monitorPtr

Definition at line 24 of file GenericElementInterface.hpp.

restartRunStep

int GenericElementInterface::restartRunStep

Definition at line 22 of file GenericElementInterface.hpp.

---

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

• tutorials/src/GenericElementInterface.hpp
• users_modules/basic_finite_elements/src/GenericElementInterface.hpp