#include "tutorials/cor-0to1/src/UnsaturatedFlow.hpp"

Inheritance diagram for MixTransport::UnsaturatedFlowElement::MonitorPostProc:

Collaboration diagram for MixTransport::UnsaturatedFlowElement::MonitorPostProc:

Public Member Functions
	MonitorPostProc (UnsaturatedFlowElement &ctx, boost::shared_ptr< PostProcEle > &post_proc, boost::shared_ptr< ForcesAndSourcesCore > flux_Integrate, const int frequency)

MoFEMErrorCode	preProcess ()
	Pre-processing function executed at loop initialization.

MoFEMErrorCode	operator() ()
	Main operator function executed for each loop iteration.

MoFEMErrorCode	postProcess ()
	Post-processing function executed at loop completion.

Public Member Functions inherited from MoFEM::FEMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
	Query interface for type casting.

	FEMethod ()=default
	Default constructor.

auto	getFEName () const
	Get the name of the current finite element.

auto	getDataDofsPtr () const
	Get pointer to DOF data for the current finite element.

auto	getDataVectorDofsPtr () const
	Get pointer to vector DOF data for the current finite element.

const FieldEntity_vector_view &	getDataFieldEnts () const
	Get reference to data field entities for the current finite element.

boost::shared_ptr< FieldEntity_vector_view > &	getDataFieldEntsPtr () const
	Get shared pointer to data field entities for the current finite element.

auto &	getRowFieldEnts () const
	Get reference to row field entities for the current finite element.

auto &	getRowFieldEntsPtr () const
	Get shared pointer to row field entities for the current finite element.

auto &	getColFieldEnts () const
	Get reference to column field entities for the current finite element.

auto &	getColFieldEntsPtr () const
	Get shared pointer to column field entities for the current finite element.

auto	getRowDofsPtr () const
	Get pointer to row DOFs for the current finite element.

auto	getColDofsPtr () const
	Get pointer to column DOFs for the current finite element.

auto	getNumberOfNodes () const
	Get the number of nodes in the current finite element.

EntityHandle	getFEEntityHandle () const
	Get the entity handle of the current finite element.

MoFEMErrorCode	getNodeData (const std::string field_name, VectorDouble &data, const bool reset_dofs=true)
	Get nodal data for a specific field.

Public Member Functions inherited from MoFEM::BasicMethod
	BasicMethod ()
	Default constructor.

virtual	~BasicMethod ()=default
	Virtual destructor.

int	getNinTheLoop () const
	Get current loop iteration index.

int	getLoopSize () const
	Get total loop size.

auto	getLoHiFERank () const
	Get processor rank range for finite element iteration.

auto	getLoFERank () const
	Get lower processor rank for finite element iteration.

auto	getHiFERank () const
	Get upper processor rank for finite element iteration.

unsigned int	getFieldBitNumber (std::string field_name) const
	Get bit number for a specific field by name.

MoFEMErrorCode	copyBasicMethod (const BasicMethod &basic)
	Copy data from another BasicMethod instance.

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

Public Member Functions inherited from MoFEM::KspMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
	Query interface for type casting.

	KspMethod ()
	Default constructor.

virtual	~KspMethod ()=default
	Virtual destructor.

MoFEMErrorCode	copyKsp (const KspMethod &ksp)
	Copy data from another KSP method.

Public Member Functions inherited from MoFEM::PetscData
	PetscData ()
	Default constructor.

virtual	~PetscData ()=default
	Virtual destructor.

MoFEMErrorCode	copyPetscData (const PetscData &petsc_data)
	Copy PETSc data from another instance.

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
	Query interface for type casting.

	SnesMethod ()
	Default constructor.

virtual	~SnesMethod ()=default
	Virtual destructor.

MoFEMErrorCode	copySnes (const SnesMethod &snes)
	Copy SNES data from another instance.

Public Member Functions inherited from MoFEM::TSMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
	Query interface for type casting.

	TSMethod ()
	Default constructor.

virtual	~TSMethod ()=default
	Virtual destructor.

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

Public Member Functions inherited from MoFEM::TaoMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
	Query interface for type casting.

	TaoMethod ()
	Default constructor.

virtual	~TaoMethod ()=default
	Virtual destructor.

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

Public Attributes
UnsaturatedFlowElement &	cTx

boost::shared_ptr< PostProcEle >	postProc

boost::shared_ptr< ForcesAndSourcesCore >	fluxIntegrate

const int	fRequency

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

boost::shared_ptr< const NumeredEntFiniteElement >	numeredEntFiniteElementPtr
	Shared pointer to finite element database structure.

boost::function< bool(FEMethod *fe_method_ptr)>	exeTestHook
	Test function to determine if element should be skipped.

Public Attributes inherited from MoFEM::BasicMethod
int	nInTheLoop
	Current index of processed method in the loop.

int	loopSize
	Total number of methods to process in the loop.

std::pair< int, int >	loHiFERank
	Processor rank range for distributed finite element iteration.

int	rAnk
	Current processor rank in MPI communicator.

int	sIze
	Total number of processors in MPI communicator.

const RefEntity_multiIndex *	refinedEntitiesPtr
	Pointer to container of refined MoFEM DOF entities.

const RefElement_multiIndex *	refinedFiniteElementsPtr
	Pointer to container of refined finite element entities.

const Problem *	problemPtr
	Raw pointer to current MoFEM problem instance.

const Field_multiIndex *	fieldsPtr
	Raw pointer to fields multi-index container.

const FieldEntity_multiIndex *	entitiesPtr
	Raw pointer to container of field entities.

const DofEntity_multiIndex *	dofsPtr
	Raw pointer to container of degree of freedom entities.

const FiniteElement_multiIndex *	finiteElementsPtr
	Raw pointer to container of finite elements.

const EntFiniteElement_multiIndex *	finiteElementsEntitiesPtr
	Raw pointer to container of finite element entities.

const FieldEntityEntFiniteElementAdjacencyMap_multiIndex *	adjacenciesPtr
	Raw pointer to container of adjacencies between DOFs and finite elements.

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

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

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

boost::movelib::unique_ptr< bool >	vecAssembleSwitch
	Switch for vector assembly operations.

boost::movelib::unique_ptr< bool >	matAssembleSwitch
	Switch for matrix assembly operations.

boost::weak_ptr< CacheTuple >	cacheWeakPtr
	Weak pointer to cached entity data.

Public Attributes inherited from MoFEM::KspMethod
KSPContext	ksp_ctx
	Current KSP computation context.

KSP	ksp
	PETSc KSP linear solver object.

Vec &	ksp_f
	Reference to residual vector in KSP context.

Mat &	ksp_A
	Reference to system matrix in KSP context.

Mat &	ksp_B
	Reference to preconditioner matrix in KSP context.

Public Attributes inherited from MoFEM::PetscData
Switches	data_ctx
	Current data context switches.

Vec	f
	PETSc residual vector.

Mat	A
	PETSc Jacobian matrix.

Mat	B
	PETSc preconditioner matrix.

Vec	x
	PETSc solution vector.

Vec	dx
	PETSc solution increment vector.

Vec	x_t
	PETSc first time derivative vector.

Vec	x_tt
	PETSc second time derivative vector.

Public Attributes inherited from MoFEM::SnesMethod
SNESContext	snes_ctx
	Current SNES computation context.

SNES	snes
	PETSc SNES nonlinear solver object.

Vec &	snes_x
	Reference to current solution state vector.

Vec &	snes_dx
	Reference to solution update/increment vector.

Vec &	snes_f
	Reference to residual vector.

Mat &	snes_A
	Reference to Jacobian matrix.

Mat &	snes_B
	Reference to preconditioner of Jacobian matrix.

Public Attributes inherited from MoFEM::TSMethod
TS	ts
	PETSc time stepping solver object.

TSContext	ts_ctx
	Current TS computation context.

PetscInt	ts_step
	Current time step number.

PetscReal	ts_a
	Shift parameter for U_t (see PETSc Time Solver documentation)

PetscReal	ts_aa
	Shift parameter for U_tt (second time derivative)

PetscReal	ts_t
	Current time value.

PetscReal	ts_dt
	Current time step size.

Vec &	ts_u
	Reference to current state vector U(t)

Vec &	ts_u_t
	Reference to first time derivative of state vector dU/dt.

Vec &	ts_u_tt
	Reference to second time derivative of state vector d²U/dt²

Vec &	ts_F
	Reference to residual vector F(t,U,U_t,U_tt)

Mat &	ts_A
	Reference to Jacobian matrix: dF/dU + adF/dU_t + aadF/dU_tt.

Mat &	ts_B
	Reference to preconditioner matrix for ts_A.

Public Attributes inherited from MoFEM::TaoMethod
TAOContext	tao_ctx
	Current TAO computation context.

Tao	tao
	PETSc TAO optimization solver object.

Vec &	tao_x
	Reference to optimization variables vector.

Vec &	tao_f
	Reference to gradient vector.

Mat &	tao_A
	Reference to Hessian matrix.

Mat &	tao_B
	Reference to preconditioner matrix for Hessian.

Additional Inherited Members
Public Types inherited from MoFEM::KspMethod
enum	KSPContext { CTX_SETFUNCTION , CTX_OPERATORS , CTX_KSPNONE }
	Context enumeration for KSP solver phases. 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 }
	Enumeration for data context flags. More...

using	Switches = std::bitset< 8 >
	Bitset type for context switches.

Public Types inherited from MoFEM::SnesMethod
enum	SNESContext { CTX_SNESSETFUNCTION , CTX_SNESSETJACOBIAN , CTX_SNESNONE }
	Context enumeration for SNES solver phases. More...

Public Types inherited from MoFEM::TSMethod
enum	TSContext { CTX_TSSETRHSFUNCTION , CTX_TSSETRHSJACOBIAN , CTX_TSSETIFUNCTION , CTX_TSSETIJACOBIAN , CTX_TSTSMONITORSET , CTX_TSNONE }
	Context enumeration for TS solver phases. More...

Public Types inherited from MoFEM::TaoMethod
enum	TAOContext { CTX_TAO_OBJECTIVE , CTX_TAO_GRADIENT , CTX_TAO_HESSIAN , CTX_TAO_NONE }
	Context enumeration for TAO solver phases. More...

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.

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

static constexpr Switches	CtxSetF = PetscData::Switches(CTX_SET_F)
	Residual vector switch.

static constexpr Switches	CtxSetA = PetscData::Switches(CTX_SET_A)
	Jacobian matrix switch.

static constexpr Switches	CtxSetB = PetscData::Switches(CTX_SET_B)
	Preconditioner matrix switch.

static constexpr Switches	CtxSetX = PetscData::Switches(CTX_SET_X)
	Solution vector switch.

static constexpr Switches	CtxSetDX = PetscData::Switches(CTX_SET_DX)
	Solution increment switch.

static constexpr Switches	CtxSetX_T = PetscData::Switches(CTX_SET_X_T)
	First time derivative switch.

static constexpr Switches	CtxSetX_TT = PetscData::Switches(CTX_SET_X_TT)
	Second time derivative switch.

static constexpr Switches	CtxSetTime = PetscData::Switches(CTX_SET_TIME)
	Time value switch.

Detailed Description

Finite element implementation called by TS monitor. Element calls other finite elements to evaluate material properties and save results on the mesh.

Note: Element overloaded only FEMethod::postProcess methods where other elements are called.

Definition at line 1070 of file UnsaturatedFlow.hpp.

Constructor & Destructor Documentation

◆ MonitorPostProc()

MixTransport::UnsaturatedFlowElement::MonitorPostProc::MonitorPostProc	(	UnsaturatedFlowElement &	ctx,
		boost::shared_ptr< PostProcEle > &	post_proc,
		boost::shared_ptr< ForcesAndSourcesCore >	flux_Integrate,
		const int	frequency
	)

inline

Definition at line 1078 of file UnsaturatedFlow.hpp.

1082 : cTx(ctx), postProc(post_proc), fluxIntegrate(flux_Integrate),

1083 fRequency(frequency) {}

MixTransport::UnsaturatedFlowElement::MonitorPostProc::postProc

boost::shared_ptr< PostProcEle > postProc

Definition UnsaturatedFlow.hpp:1073

MixTransport::UnsaturatedFlowElement::MonitorPostProc::fluxIntegrate

boost::shared_ptr< ForcesAndSourcesCore > fluxIntegrate

Definition UnsaturatedFlow.hpp:1074

MixTransport::UnsaturatedFlowElement::MonitorPostProc::cTx

UnsaturatedFlowElement & cTx

Definition UnsaturatedFlow.hpp:1072

MixTransport::UnsaturatedFlowElement::MonitorPostProc::fRequency

const int fRequency

Definition UnsaturatedFlow.hpp:1076

Member Function Documentation

◆ operator()()

MoFEMErrorCode MixTransport::UnsaturatedFlowElement::MonitorPostProc::operator() ( )

inlinevirtual

Main operator function executed for each loop iteration.

This virtual function is called for every item (finite element, entity, etc.) in the loop. It is the core computation function typically used for:

Calculating element local matrices and vectors
Assembling contributions to global system
Element-level post-processing operations

Returns: Error code indicating success or failure

Reimplemented from MoFEM::BasicMethod.

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1090 of file UnsaturatedFlow.hpp.

                                {
      MoFEMFunctionBegin;
      MoFEMFunctionReturn(0);
    }

◆ postProcess()

MoFEMErrorCode MixTransport::UnsaturatedFlowElement::MonitorPostProc::postProcess ( )

inlinevirtual

Post-processing function executed at loop completion.

This virtual function is called once at the end of the loop. It is typically used for:

Assembling matrices and vectors to global system
Computing global variables (e.g., total internal energy)
Finalizing computation results
Cleanup operations

Example of iterating over DOFs:

for(_IT_GET_FEROW_BY_NAME_DOFS_FOR_LOOP_(this,"DISPLACEMENT",it)) { 
  // Process each DOF
}

Returns: Error code indicating success or failure

Reimplemented from MoFEM::BasicMethod.

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1095 of file UnsaturatedFlow.hpp.

                                 {
      MoFEMFunctionBegin;
 
      // Get time step
      int step;
      CHKERR TSGetTimeStepNumber(ts, &step);
 
      if ((step) % fRequency == 0) {
        // Post-process results and save in the file
        PetscPrintf(PETSC_COMM_WORLD, "Output results %d - %d\n", step,
                    fRequency);
        CHKERR DMoFEMLoopFiniteElements(cTx.dM, "MIX", postProc);
        CHKERR postProc->writeFile(
            string("out_") + boost::lexical_cast<std::string>(step) + ".h5m");
      }
 
      // Integrate fluxes on faces where pressure head is applied
      CHKERR VecZeroEntries(cTx.ghostFlux);
      CHKERR VecGhostUpdateBegin(cTx.ghostFlux, INSERT_VALUES, SCATTER_FORWARD);
      CHKERR VecGhostUpdateEnd(cTx.ghostFlux, INSERT_VALUES, SCATTER_FORWARD);
      // Run finite element to integrate fluxes
      CHKERR DMoFEMLoopFiniteElements(cTx.dM, "MIX_BCVALUE", fluxIntegrate);
      CHKERR VecAssemblyBegin(cTx.ghostFlux);
      CHKERR VecAssemblyEnd(cTx.ghostFlux);
      // accumulate errors from processors
      CHKERR VecGhostUpdateBegin(cTx.ghostFlux, ADD_VALUES, SCATTER_REVERSE);
      CHKERR VecGhostUpdateEnd(cTx.ghostFlux, ADD_VALUES, SCATTER_REVERSE);
      // scatter errors to all processors
      CHKERR VecGhostUpdateBegin(cTx.ghostFlux, INSERT_VALUES, SCATTER_FORWARD);
      CHKERR VecGhostUpdateEnd(cTx.ghostFlux, INSERT_VALUES, SCATTER_FORWARD);
      double *ghost_flux;
      CHKERR VecGetArray(cTx.ghostFlux, &ghost_flux);
      CHKERR PetscPrintf(PETSC_COMM_WORLD, "Flux at time %6.4g %6.4g\n", ts_t,
                         ghost_flux[0]);
      CHKERR VecRestoreArray(cTx.ghostFlux, &ghost_flux);
 
      MoFEMFunctionReturn(0);
    }

◆ preProcess()

MoFEMErrorCode MixTransport::UnsaturatedFlowElement::MonitorPostProc::preProcess ( )

inlinevirtual

Pre-processing function executed at loop initialization.

This virtual function is called once at the beginning of the loop. It is typically used for:

Zeroing matrices and vectors
Computing shape functions on reference elements
Preprocessing boundary conditions
Setting up initial computation state

Returns: Error code indicating success or failure

Reimplemented from MoFEM::BasicMethod.

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1085 of file UnsaturatedFlow.hpp.

                                {
      MoFEMFunctionBegin;
      MoFEMFunctionReturn(0);
    }

Member Data Documentation

◆ cTx

UnsaturatedFlowElement& MixTransport::UnsaturatedFlowElement::MonitorPostProc::cTx

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1072 of file UnsaturatedFlow.hpp.

◆ fluxIntegrate

boost::shared_ptr<ForcesAndSourcesCore> MixTransport::UnsaturatedFlowElement::MonitorPostProc::fluxIntegrate

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1074 of file UnsaturatedFlow.hpp.

◆ fRequency

const int MixTransport::UnsaturatedFlowElement::MonitorPostProc::fRequency

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1076 of file UnsaturatedFlow.hpp.

◆ postProc

boost::shared_ptr<PostProcEle> MixTransport::UnsaturatedFlowElement::MonitorPostProc::postProc

Examples: mofem/tutorials/cor-0to1/src/UnsaturatedFlow.hpp.

Definition at line 1073 of file UnsaturatedFlow.hpp.

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

tutorials/cor-0to1/src/UnsaturatedFlow.hpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MonitorPostProc()

Member Function Documentation

◆ operator()()

◆ postProcess()

◆ preProcess()

Member Data Documentation

◆ cTx

◆ fluxIntegrate

◆ fRequency

◆ postProc