Inheritance diagram for PhotonDiffusion::Monitor:

Collaboration diagram for PhotonDiffusion::Monitor:

Public Member Functions
	Monitor (SmartPetscObj< DM > dm, boost::shared_ptr< PostProcEle > post_proc, boost::shared_ptr< PostProcFaceEle > skin_post_proc, boost::shared_ptr< BoundaryEle > skin_post_proc_integ, boost::shared_ptr< CommonData > common_data_ptr)

MoFEMErrorCode	preProcess ()
	function is run at the beginning of loop

MoFEMErrorCode	operator() ()
	function is run for every finite element

MoFEMErrorCode	postProcess ()
	function is run at the end of loop

Public Member Functions inherited from MoFEM::FEMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	FEMethod ()=default

auto	getFEName () const
	get finite element name

auto	getDataDofsPtr () const

auto	getDataVectorDofsPtr () const

const FieldEntity_vector_view &	getDataFieldEnts () const

boost::shared_ptr< FieldEntity_vector_view > &	getDataFieldEntsPtr () const

auto &	getRowFieldEnts () const

auto &	getRowFieldEntsPtr () const

auto &	getColFieldEnts () const

auto &	getColFieldEntsPtr () const

auto	getRowDofsPtr () const

auto	getColDofsPtr () const

auto	getNumberOfNodes () const

EntityHandle	getFEEntityHandle () const

MoFEMErrorCode	getNodeData (const std::string field_name, VectorDouble &data, const bool reset_dofs=true)

Public Member Functions inherited from MoFEM::BasicMethod
	BasicMethod ()

virtual	~BasicMethod ()=default

int	getNinTheLoop () const
	get number of evaluated element in the loop

int	getLoopSize () const
	get loop size

auto	getLoHiFERank () const
	Get lo and hi processor rank of iterated entities.

auto	getLoFERank () const
	Get upper rank in loop for iterating elements.

auto	getHiFERank () const
	Get upper rank in loop for iterating elements.

unsigned int	getFieldBitNumber (std::string field_name) const

MoFEMErrorCode	copyBasicMethod (const BasicMethod &basic)
	Copy data from other base method to this base method.

boost::weak_ptr< CacheTuple >	getCacheWeakPtr () const
	Get the cache weak ptr object.

Public Member Functions inherited from MoFEM::KspMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	KspMethod ()

virtual	~KspMethod ()=default

MoFEMErrorCode	copyKsp (const KspMethod &ksp)
	copy data form another method

Public Member Functions inherited from MoFEM::PetscData
	PetscData ()

virtual	~PetscData ()=default

MoFEMErrorCode	copyPetscData (const PetscData &petsc_data)

Public Member Functions inherited from MoFEM::UnknownInterface
template<class IFACE >
MoFEMErrorCode	registerInterface (bool error_if_registration_failed=true)
	Register interface.

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface reference to pointer of interface.

template<class IFACE >
MoFEMErrorCode	getInterface (IFACE **const iface) const
	Get interface pointer to pointer of interface.

template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get interface pointer to pointer of interface.

template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get reference to interface.

template<class IFACE >
IFACE *	getInterface () const
	Function returning pointer to interface.

virtual	~UnknownInterface ()=default

Public Member Functions inherited from MoFEM::SnesMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	SnesMethod ()

virtual	~SnesMethod ()=default

MoFEMErrorCode	copySnes (const SnesMethod &snes)
	Copy snes data.

Public Member Functions inherited from MoFEM::TSMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	TSMethod ()

virtual	~TSMethod ()=default

MoFEMErrorCode	copyTs (const TSMethod &ts)
	Copy TS solver data.

Public Member Functions inherited from MoFEM::TaoMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	TaoMethod ()

virtual	~TaoMethod ()=default

MoFEMErrorCode	copyTao (const TaoMethod &tao)
	Copy TAO data.

Private Attributes
SmartPetscObj< DM >	dM

boost::shared_ptr< PostProcEle >	postProc

boost::shared_ptr< PostProcFaceEle >	skinPostProc

boost::shared_ptr< BoundaryEle >	skinPostProcInteg

boost::shared_ptr< CommonData >	commonDataPtr

Additional Inherited Members
Public Types inherited from MoFEM::KspMethod
enum	KSPContext { CTX_SETFUNCTION , CTX_OPERATORS , CTX_KSPNONE }
	pass information about context of KSP/DM for with finite element is computed More...

Public Types inherited from MoFEM::PetscData
enum	DataContext { CTX_SET_NONE = 0 , CTX_SET_F = 1 << 0 , CTX_SET_A = 1 << 1 , CTX_SET_B = 1 << 2 , CTX_SET_X = 1 << 3 , CTX_SET_DX = 1 << 4 , CTX_SET_X_T = 1 << 5 , CTX_SET_X_TT = 1 << 6 , CTX_SET_TIME = 1 << 7 }

using	Switches = std::bitset<8>

Public Types inherited from MoFEM::SnesMethod
enum	SNESContext { CTX_SNESSETFUNCTION , CTX_SNESSETJACOBIAN , CTX_SNESNONE }

Public Types inherited from MoFEM::TSMethod
enum	TSContext { CTX_TSSETRHSFUNCTION , CTX_TSSETRHSJACOBIAN , CTX_TSSETIFUNCTION , CTX_TSSETIJACOBIAN , CTX_TSTSMONITORSET , CTX_TSNONE }

Public Types inherited from MoFEM::TaoMethod
enum	TAOContext { CTX_TAO_OBJECTIVE , CTX_TAO_GRADIENT , CTX_TAO_HESSIAN , CTX_TAO_NONE }

Static Public Member Functions inherited from MoFEM::UnknownInterface
static MoFEMErrorCode	getLibVersion (Version &version)
	Get library version.

static MoFEMErrorCode	getFileVersion (moab::Interface &moab, Version &version)
	Get database major version.

static MoFEMErrorCode	setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
	Get database major version.

static MoFEMErrorCode	getInterfaceVersion (Version &version)
	Get database major version.

Public Attributes inherited from MoFEM::FEMethod
std::string	feName
	Name of finite element.

boost::shared_ptr< const NumeredEntFiniteElement >	numeredEntFiniteElementPtr

boost::function< bool(FEMethod *fe_method_ptr)>	exeTestHook
	Tet if element to skip element.

Public Attributes inherited from MoFEM::BasicMethod
int	nInTheLoop
	number currently of processed method

int	loopSize
	local number oe methods to process

std::pair< int, int >	loHiFERank
	Llo and hi processor rank of iterated entities.

int	rAnk
	processor rank

int	sIze
	number of processors in communicator

const RefEntity_multiIndex *	refinedEntitiesPtr
	container of mofem dof entities

const RefElement_multiIndex *	refinedFiniteElementsPtr
	container of mofem finite element entities

const Problem *	problemPtr
	raw pointer to problem

const Field_multiIndex *	fieldsPtr
	raw pointer to fields container

const FieldEntity_multiIndex *	entitiesPtr
	raw pointer to container of field entities

const DofEntity_multiIndex *	dofsPtr
	raw pointer container of dofs

const FiniteElement_multiIndex *	finiteElementsPtr
	raw pointer to container finite elements

const EntFiniteElement_multiIndex *	finiteElementsEntitiesPtr

const FieldEntityEntFiniteElementAdjacencyMap_multiIndex *	adjacenciesPtr

boost::function< MoFEMErrorCode()>	preProcessHook
	Hook function for pre-processing.

boost::function< MoFEMErrorCode()>	postProcessHook
	Hook function for post-processing.

boost::function< MoFEMErrorCode()>	operatorHook
	Hook function for operator.

boost::movelib::unique_ptr< bool >	vecAssembleSwitch

boost::movelib::unique_ptr< bool >	matAssembleSwitch

boost::weak_ptr< CacheTuple >	cacheWeakPtr

Public Attributes inherited from MoFEM::KspMethod
KSPContext	ksp_ctx
	Context.

KSP	ksp
	KSP solver.

Vec &	ksp_f

Mat &	ksp_A

Mat &	ksp_B

Public Attributes inherited from MoFEM::PetscData
Switches	data_ctx

Vec	f

Mat	A

Mat	B

Vec	x

Vec	dx

Vec	x_t

Vec	x_tt

Public Attributes inherited from MoFEM::SnesMethod
SNESContext	snes_ctx

SNES	snes
	snes solver

Vec &	snes_x
	state vector

Vec &	snes_dx
	solution update

Vec &	snes_f
	residual

Mat &	snes_A
	jacobian matrix

Mat &	snes_B
	preconditioner of jacobian matrix

Public Attributes inherited from MoFEM::TSMethod
TS	ts
	time solver

TSContext	ts_ctx

PetscInt	ts_step
	time step number

PetscReal	ts_a
	shift for U_t (see PETSc Time Solver)

PetscReal	ts_aa
	shift for U_tt shift for U_tt

PetscReal	ts_t
	time

PetscReal	ts_dt
	time step size

Vec &	ts_u
	state vector

Vec &	ts_u_t
	time derivative of state vector

Vec &	ts_u_tt
	second time derivative of state vector

Vec &	ts_F
	residual vector

Mat &	ts_A

Mat &	ts_B
	Preconditioner for ts_A.

Public Attributes inherited from MoFEM::TaoMethod
TAOContext	tao_ctx

Tao	tao
	tao solver

Vec &	tao_x

Vec &	tao_f
	state vector

Mat &	tao_A
	gradient vector

Mat &	tao_B
	hessian matrix

Static Public Attributes inherited from MoFEM::PetscData
static constexpr Switches	CtxSetNone = PetscData::Switches(CTX_SET_NONE)

static constexpr Switches	CtxSetF = PetscData::Switches(CTX_SET_F)

static constexpr Switches	CtxSetA = PetscData::Switches(CTX_SET_A)

static constexpr Switches	CtxSetB = PetscData::Switches(CTX_SET_B)

static constexpr Switches	CtxSetX = PetscData::Switches(CTX_SET_X)

static constexpr Switches	CtxSetDX = PetscData::Switches(CTX_SET_DX)

static constexpr Switches	CtxSetX_T = PetscData::Switches(CTX_SET_X_T)

static constexpr Switches	CtxSetX_TT = PetscData::Switches(CTX_SET_X_TT)

static constexpr Switches	CtxSetTime = PetscData::Switches(CTX_SET_TIME)

Detailed Description

Definition at line 142 of file photon_diffusion.cpp.

Constructor & Destructor Documentation

◆ Monitor()

PhotonDiffusion::Monitor::Monitor	(	SmartPetscObj< DM >	dm,
		boost::shared_ptr< PostProcEle >	post_proc,
		boost::shared_ptr< PostProcFaceEle >	skin_post_proc,
		boost::shared_ptr< BoundaryEle >	skin_post_proc_integ,
		boost::shared_ptr< CommonData >	common_data_ptr )

inline

Examples: photon_diffusion.cpp.

Definition at line 144 of file photon_diffusion.cpp.

        : dM(dm), postProc(post_proc), skinPostProc(skin_post_proc),
          skinPostProcInteg(skin_post_proc_integ),
          commonDataPtr(common_data_ptr){};

Member Function Documentation

◆ operator()()

MoFEMErrorCode PhotonDiffusion::Monitor::operator() ( )

inlinevirtual

function is run for every finite element

It is used to calculate element local matrices and assembly. It can be used for post-processing.

Reimplemented from MoFEM::BasicMethod.

Examples: photon_diffusion.cpp.

Definition at line 156 of file photon_diffusion.cpp.

                                {
      MoFEMFunctionBegin;
      MoFEMFunctionReturn(0);
    }

◆ postProcess()

MoFEMErrorCode PhotonDiffusion::Monitor::postProcess ( )

inlinevirtual

function is run at the end of loop

It is used to assembly matrices and vectors, calculating global variables, f.e. total internal energy, ect.

Iterating over dofs: Example1 iterating over dofs in row by name of the field for(IT_GET_FEROW_BY_NAME_DOFS_FOR_LOOP(this,"DISPLACEMENT",it)) { ... }

Reimplemented from MoFEM::BasicMethod.

Examples: photon_diffusion.cpp.

Definition at line 161 of file photon_diffusion.cpp.

                                 {
      MoFEMFunctionBegin;
 
      CHKERR VecZeroEntries(commonDataPtr->petscVec);
      CHKERR VecGhostUpdateBegin(commonDataPtr->petscVec, INSERT_VALUES,
                                 SCATTER_FORWARD);
      CHKERR VecGhostUpdateEnd(commonDataPtr->petscVec, INSERT_VALUES,
                               SCATTER_FORWARD);
      CHKERR DMoFEMLoopFiniteElements(dM, "CAMERA_FE", skinPostProcInteg);
      CHKERR VecAssemblyBegin(commonDataPtr->petscVec);
      CHKERR VecAssemblyEnd(commonDataPtr->petscVec);
      CHKERR VecGhostUpdateBegin(commonDataPtr->petscVec, ADD_VALUES,
                                 SCATTER_REVERSE);
      CHKERR VecGhostUpdateEnd(commonDataPtr->petscVec, ADD_VALUES,
                               SCATTER_REVERSE);
      CHKERR VecGhostUpdateBegin(commonDataPtr->petscVec, INSERT_VALUES,
                                 SCATTER_FORWARD);
      CHKERR VecGhostUpdateEnd(commonDataPtr->petscVec, INSERT_VALUES,
                               SCATTER_FORWARD);
      const double *array;
      CHKERR VecGetArrayRead(commonDataPtr->petscVec, &array);
      MOFEM_LOG("PHOTON", Sev::inform) << "Fluence rate integral: " << array[0];
 
      if (ts_step % save_every_nth_step == 0) {
        if (output_volume) {
          CHKERR DMoFEMLoopFiniteElements(dM, "dFE", postProc);
          CHKERR postProc->writeFile("out_volume_" +
                                     boost::lexical_cast<std::string>(ts_step) +
                                     ".h5m");
        }
        if (output_camera && skinPostProc) {
          CHKERR DMoFEMLoopFiniteElements(dM, "CAMERA_FE", skinPostProc);
          CHKERR skinPostProc->writeFile(
              "out_camera_" + boost::lexical_cast<std::string>(ts_step) +
              ".h5m");
        }
      }
      MoFEMFunctionReturn(0);
    }

◆ preProcess()

MoFEMErrorCode PhotonDiffusion::Monitor::preProcess ( )

inlinevirtual

function is run at the beginning of loop

It is used to zeroing matrices and vectors, calculation of shape functions on reference element, preprocessing boundary conditions, etc.

Reimplemented from MoFEM::BasicMethod.

Examples: photon_diffusion.cpp.

Definition at line 152 of file photon_diffusion.cpp.

                                {
      MoFEMFunctionBegin;
      MoFEMFunctionReturn(0);
    }

Member Data Documentation

◆ commonDataPtr

boost::shared_ptr<CommonData> PhotonDiffusion::Monitor::commonDataPtr

private

Examples: photon_diffusion.cpp.

Definition at line 206 of file photon_diffusion.cpp.

◆ dM

SmartPetscObj<DM> PhotonDiffusion::Monitor::dM

private

Examples: photon_diffusion.cpp.

Definition at line 202 of file photon_diffusion.cpp.

◆ postProc

boost::shared_ptr<PostProcEle> PhotonDiffusion::Monitor::postProc

private

Examples: photon_diffusion.cpp.

Definition at line 203 of file photon_diffusion.cpp.

◆ skinPostProc

boost::shared_ptr<PostProcFaceEle> PhotonDiffusion::Monitor::skinPostProc

private

Examples: photon_diffusion.cpp.

Definition at line 204 of file photon_diffusion.cpp.

◆ skinPostProcInteg

boost::shared_ptr<BoundaryEle> PhotonDiffusion::Monitor::skinPostProcInteg

private

Examples: photon_diffusion.cpp.

Definition at line 205 of file photon_diffusion.cpp.

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

tutorials/scl-10/photon_diffusion.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Monitor()

Member Function Documentation

◆ operator()()

◆ postProcess()

◆ preProcess()

Member Data Documentation

◆ commonDataPtr

◆ dM

◆ postProc

◆ skinPostProc

◆ skinPostProcInteg