Basic class for the standard hydraulic physics plugin object. More...

#include <gmpHydraulicMultiPhaseFlow.h>

Inheritance diagram for GmpHydraulicMultiPhaseFlow:

[legend]

Collaboration diagram for GmpHydraulicMultiPhaseFlow:

[legend]

Public Member Functions
	GmpHydraulicMultiPhaseFlow (const char pluginType, GmSimulationData simulation, QString id, QString description, const GmpFemPhysicsCommonMaterialFactory *matFactory, const GmLogCategory &logger)
	Constructor. Will be called by the plugin loading code.

virtual	~GmpHydraulicMultiPhaseFlow ()
	Destructor.

virtual const QVariantMap *	physicsMetaDataMap ()
	Returns a reference for the single Hydraulics attribute map, built when the function is called for the first time.

virtual GmpFemPhysics::FemResultType	fillElementData (const GmElement *e, GmpFemMatrixSet &elemMatrices, GmpFemVectorSet &elemVectors)
	Fills the element matrices and vectors for a generic element.

virtual bool	fixedNodalForcesBc (QVector< int > &nodes, QVector< int > &dof, QVector< double > &values) const
	See comments on base class. Fills vectors with prescribed nodal forces - flow.

virtual bool	fixedNodalDofsBc (QVector< int > &nodes, QVector< int > &dof, QVector< double > &values, bool *constantValues) const
	See comments on base class. Fills vectors with prescribed node pore pressures.

virtual bool	calcDerivedResults (bool nonLinearSolver)
	Calc velocity and flow on nodes and/or Gauss points.

virtual void	fillStorageCompMatrix (const GmElement e, const GmVector coord, int ip, GmMatrix &Sww, GmMatrix &Swc, GmMatrix &Scw, GmMatrix &Scc, const GmVector &N, double c) const
	Calculates the stiffness matrix of "storage / compressibility" for element 'e' at the given integration point (coord, ip) storing the result at the Sww,Swc, Scw, Scc matrices. Npw is the shape function vector and c a constant equal to w * h * detJ.

virtual void	fillFlowMatrix (const GmElement e, const GmVector coord, int ip, GmMatrix &Kc, GmMatrix &Kwc, GmMatrix &Kcc, const GmMatrix &Bp, double c) const
	Calculates the flow stiffness matrix due to permeability contribution or permeability matrix for element 'e' at the given integration point (coord, ip) storing the result at the Kc matrix. Bp is the strain pore pressure matrix and c a constant equal to w * h * detJ.

virtual void	fillElementFluidPorePressure (const GmElement *e, GmVector &Pce) const
	Given an element, fills the vector pc with nodal fluid pore pressure. The vector should have size equal to the number of calculated nodes.

virtual void	FillDofIndexPosition (const GmElement *e, QVector< int > &iPe, QVector< int > &iPfe) const
	Fills the position index of the two hydraulic degrees of freedom. the implementation supports order of the defined state variables i.e {Pw, Pc} or {Pw, Pc}.

virtual void	fillDampingMatrix (const GmElement *e, GmMatrix &C, const GmMatrix &Sww, const GmMatrix &Swc, const GmMatrix &Scw, const GmMatrix &Scc, const QVector< int > &iPw, const QVector< int > &iPc) const
	Fills the Damping matrix with the computed "storage/compressibility" Matrizes Returns C = Sww + Swc + Scw + Scc, where: Sww is the "storage/compressibility" Matrix of the water Scc is the "storage/compressibility" Matrix of the fluid.

virtual void	fillStiffnessMatrix (const GmElement *e, GmMatrix &K, const GmMatrix &Kww, const GmMatrix &Kwc, const GmMatrix &Kcc, const QVector< int > &iPw, const QVector< int > &iPc) const
	Fills the Stiffness matrix with the computed "permeability" Matrices Returns K = \| Kww Kwc \| \| Kwc.t() Kcc \| where: Kww is the permeability Matrix of the water Kcc is the permeability Matrix of the fluid.

virtual void	fillInternalForceVector (const GmElement *e, GmVector &Fi, const GmMatrix &Kww, const GmMatrix &Kwc, const GmMatrix &Kcc, const GmVector &Pw, const GmVector &Pc, const QVector< int > &iPw, const QVector< int > &iPc) const
	Fills the Internal force vector for both fluids Returns fi = Kwwpw + Kccpc, where: Kww is the permeability Matrix of the water Kcc is the permeability Matrix of the fluid.

virtual void	gravitySupplyFluid (const GmElement e, const GmVector coord, int ip, GmVector &gFp, GmVector &gFpc, const GmMatrix &Bp, double c)

Public Member Functions inherited from GmpHydraulic
	GmpHydraulic (const char pluginType, GmSimulationData simulation, QString id, QString description, const GmpFemPhysicsCommonMaterialFactory *matFactory, const GmLogCategory &logger)
	Constructor. Will be called by the plugin loading code.

virtual	~GmpHydraulic ()
	Destructor.

virtual const char *	pluginName () const

virtual const char *	pluginType () const

virtual bool	supportsStateDumping ()

virtual FemResultType	fillElementDataForBc (const GmElement e, const GmBoundaryCondition bc, int bcIndex, int bcListIndex, int border, GmpFemMatrixSet &elemMatrices, GmpFemVectorSet &elemVectors)

virtual FemResultType	fillElementDataBc (const GmElement e, const GmBoundaryCondition bc, int bcIndex, int bcListIndex, int border, GmMatrix &elemMat, GmVector &elemVec)

virtual void	fillStorageCompMatrix (const GmElement e, const GmVector coord, int ip, GmMatrix &Sc, const GmVector &N, double c)
	Calculates the stiffness matrix of "storage / compressibility" for element 'e' at the given integration point (coord, ip) storing the result at the Sc matrix. N is the shape function vector and c a constant equal to w * h * detJ.

virtual void	fillFlowMatrix (const GmElement e, const GmVector coord, int ip, GmMatrix &Kc, const GmMatrix &Bp, double c) const
	Calculates the flow stiffness matrix due to permeability contribution or permeability matrix for element 'e' at the given integration point (coord, ip) storing the result at the Kc matrix. Bp is the strain pore pressure matrix and c a constant equal to w * h * detJ.

virtual void	fillFluidVelocity (const GmElement e, const GmVector coord, int ip, GmVector &Vip, const GmVector &Pe, const GmMatrix &Bp) const
	Evaluates velocity at integration points (it should be improved to consider gravity effect)

virtual void	fillElementPorePressure (const GmElement *e, GmVector &pe)
	Given an element, fills the vector pe with nodal pore pressure. The vector should have size equal to the number of calculated nodes.

virtual void	gravitySupplyFluid (const GmElement e, const GmVector coord, int ip, GmVector &qext_gsf, GmMatrix &Bp, double c)

virtual void	fillSourceTermVector (const GmElement e, const GmVector coord, int ip, GmVector &St, const GmVector &N, double c)
	Calculates the source term due the porosity rate of porous eskeleton for element 'e' at the given integration point (coord, ip) storing the result at external vector. N is the shape function vector and c a constant equal to w * h * detJ.

virtual double	fillBpMatrix (const GmShape *shape, const GmVector &ncoord, const GmMatrix &X, const GmVector &N, const GmMatrix &J, GmMatrix &Bp)=0
	Given a point 'ncoord', the element coordinate matrix 'X', the point shape functions 'N' and the transformation Jacobian 'J', fills the matrix with cartesian partial derivatives Bp using the provided shape function and returns the scaled jacobian determinant.

virtual void	gravityVector (const GmElement e, const GmVector coord, int ip, GmVector &grav) const
	Returns the gravity accelaration vector.

virtual bool	isAxisymmetric ()
	Returns TRUE only for axisymmetric models.

virtual double	axisymmetricFactor (const GmElement *e, const GmMatrix &X, const GmVector &N) const
	Returns the factor that should be applied when using axis symetric elements. 1.0 for other etypes.

HMaterialPointAccessors &	hydraulicMaterialPoint ()
	Returns the hydraulic material point accessor.

Protected Types
enum	MultiPhaseStateVarIds { PC_ID = GmpHydraulic::NUM_STATEVAR_IDS , NUM_STATEVAR_IDS }
	IDs fo physics state vars. More...

enum	MultiPhaseBoundaryConditionIds { FIXED_PC_BC_ID = GmpHydraulic::NUM_BC_IDS , FIXED_QC_BC_ID , NUM_BC_IDS }
	IDs for accepted boundary condition types. More...

enum	MultiPhaseBoundaryConditionValueIds { BC_PC_ID = GmpHydraulic::NUM_BCV_IDS , BC_QWC_ID , NUM_BCV_IDS }
	IDs for property values from accepted boundary condition types. More...

Protected Member Functions
virtual const GmElementDof *	dofMapping (GmCellType type) const

Protected Member Functions inherited from GmpHydraulic
virtual bool	checkAndLoadAttributeAccessors (LuaTable &nodeTable, LuaTable &cellTable, LuaTable &gaussTable)
	Checks the loaded data.

virtual void	calcElementDerivedResultAtPoints (const GmElement *e, int resultId, const GmMatrix &evalPoints, bool evalAtIp, GmMatrix &result)
	The virtual function used by calcDerivedResults() to effectivelly calculate the velocity (resultId = 0) or the flow (resultId = 1) at the given evaluation points.

void	calcElementVelocityAtPoints (const GmElement *e, const GmMatrix &evalPoints, GmMatrix &v)
	The function responsible for effectivelly calculating the velocity at the given evaluation points, filling v.

void	calcElementFlowAtPoints (const GmElement *e, const GmMatrix &evalPoints, bool evalAtIp, GmMatrix &q)
	The function responsible for effectivelly calculating the flow at the given evaluation points, filling q.

Additional Inherited Members
Public Types inherited from GmpHydraulic
enum	HMaterialPointStates { saturated , unsaturated }

enum	PhysicsAttributeIds { ISOPARAMETRIC_ID , POROSITY_UPDATE_ID , PERMEABILITY_UPDATE_ID , USE_CONSISTENT_MATRIX_ID , VELOCITY_MODE_ID , FLOW_MODE_ID , DIRECT_ID , CGRAV_ID , VF_MODE_ID , NUM_ATTRI_IDS }
	IDs for physics attributes. More...

enum	StateVarIds { P_ID , NUM_STATEVAR_IDS }
	IDs fo physics state vars. More...

enum	NodeAttributeIds { V_NA_ID , Q_NA_ID , VF_NA_ID , NUM_NA_IDS }
	IDs for physics node attributes. More...

enum	cellAttributeIds { NUM_CA_IDS }
	IDs for physics Cell attributes. More...

enum	GaussAttributeIds { V_GA_ID , Q_GA_ID , FT_GA_ID , FTOLD_GA_ID , NUM_GA_IDS }
	IDs for physics Gauss attributes. More...

enum	ElementPropertyIds { THICKNESS_ID , GRAV_ID , SOURTERM_ID , NUM_PROPER_IDS }
	IDs for physics element properties. More...

enum	BoundaryConditionIds { FIXED_P_BC_ID , FIXED_Q_BC_ID , FIXED_SPF_BC_ID , NUM_BC_IDS }
	IDs for accepted boundary condition types. More...

enum	BoundaryConditionValueIds { BC_P_ID , BC_QW_ID , BC_IF_ID , NUM_BCV_IDS }
	IDs for property values from accepted boundary condition types. More...

Protected Attributes inherited from GmpHydraulic
HMaterialPointAccessors	_hmaterialPointAccessor
	Access to hydraulic material point.

bool	_setInitialCond
	Sets the initial conditions required by the physics.

Detailed Description

Basic class for the standard hydraulic physics plugin object.

Member Enumeration Documentation

◆ MultiPhaseBoundaryConditionIds

enum GmpHydraulicMultiPhaseFlow::MultiPhaseBoundaryConditionIds

protected

IDs for accepted boundary condition types.

Enumerator
FIXED_PC_BC_ID	Id for fixed node gas pore pressure boundary condition.
FIXED_QC_BC_ID	Id for fixed node gas flow boundary condition.
NUM_BC_IDS	The number of boundary conditions ids above.

◆ MultiPhaseBoundaryConditionValueIds

enum GmpHydraulicMultiPhaseFlow::MultiPhaseBoundaryConditionValueIds

protected

IDs for property values from accepted boundary condition types.

Enumerator
BC_PC_ID	Nodal pore pressure for fixed gas node pore pressure boundary condition.
BC_QWC_ID	Nodal pore flow for fixed node gas pore flow boundary condition.
NUM_BCV_IDS	The number of boundary conditions value ids above.

◆ MultiPhaseStateVarIds

enum GmpHydraulicMultiPhaseFlow::MultiPhaseStateVarIds

protected

IDs fo physics state vars.

Enumerator
PC_ID	Id for retrieving the accessor to the gas pore pressure state var.
NUM_STATEVAR_IDS	The number of property ids above.

Member Function Documentation

◆ calcDerivedResults()

bool GmpHydraulicMultiPhaseFlow::calcDerivedResults ( bool nonLinearSolver )

virtual

Calc velocity and flow on nodes and/or Gauss points.

Reimplemented from GmpHydraulic.

◆ fillElementData()

GmpFemPhysics::FemResultType GmpHydraulicMultiPhaseFlow::fillElementData	(	const GmElement *	e,
		GmpFemMatrixSet &	elemMatrices,
		GmpFemVectorSet &	elemVectors )

virtual

Fills the element matrices and vectors for a generic element.

Reimplemented from GmpHydraulic.

◆ fillFlowMatrix()

void GmpHydraulicMultiPhaseFlow::fillFlowMatrix	(	const GmElement *	e,
		const GmVector *	coord,
		int	ip,
		GmMatrix &	Kww,
		GmMatrix &	Kwc,
		GmMatrix &	Kcc,
		const GmMatrix &	Bp,
		double	c ) const

virtual

Calculates the flow stiffness matrix due to permeability contribution or permeability matrix for element 'e' at the given integration point (coord, ip) storing the result at the Kc matrix. Bp is the strain pore pressure matrix and c a constant equal to w * h * detJ.

This function can operate either in an iso parametric setting (Kc = n x n) or in a super parametric setting (Kc = nf x nf) where n is the number of element nodes and nf the number of element corner nodes.

Returns Kc = Bp.t() * Kaux * Bp * c, where c should be equal to w * h * detJ

◆ fillStorageCompMatrix()

void GmpHydraulicMultiPhaseFlow::fillStorageCompMatrix	(	const GmElement *	e,
		const GmVector *	coord,
		int	ip,
		GmMatrix &	Sww,
		GmMatrix &	Swc,
		GmMatrix &	Scw,
		GmMatrix &	Scc,
		const GmVector &	N,
		double	c ) const

virtual

Calculates the stiffness matrix of "storage / compressibility" for element 'e' at the given integration point (coord, ip) storing the result at the Sww,Swc, Scw, Scc matrices. Npw is the shape function vector and c a constant equal to w * h * detJ.

This function can operate either in an iso parametric setting (Sij = n x n) or in a super parametric setting (Sij = nf x nf) where n is the number of element nodes and nf the number of element corner nodes.

Returns: Sww = Npw * Mww * Npw.t() * c, Mww = 1/Qww Swc = Npw * Mwc * Npc.t() * c, Mwc = 1/Qwc Scw = Npc * Mcw * Npw.t() * c, Mcw = 1/Qcw Scc = Npc * Mcc * Npc.t() * c, Mcc = 1/Qww

where c should be equal to w * h * detJ

◆ fixedNodalDofsBc()

bool GmpHydraulicMultiPhaseFlow::fixedNodalDofsBc	(	QVector< int > &	nodes,
		QVector< int > &	dof,
		QVector< double > &	values,
		bool *	constantValues ) const

virtual

See comments on base class. Fills vectors with prescribed node pore pressures.

Reimplemented from GmpHydraulic.

◆ fixedNodalForcesBc()

bool GmpHydraulicMultiPhaseFlow::fixedNodalForcesBc	(	QVector< int > &	nodes,
		QVector< int > &	dof,
		QVector< double > &	values ) const

virtual

See comments on base class. Fills vectors with prescribed nodal forces - flow.

Reimplemented from GmpHydraulic.

◆ physicsMetaDataMap()

const QVariantMap * GmpHydraulicMultiPhaseFlow::physicsMetaDataMap ( )

virtual

Returns a reference for the single Hydraulics attribute map, built when the function is called for the first time.

Reimplemented from GmpHydraulic.

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

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MultiPhaseBoundaryConditionIds

◆ MultiPhaseBoundaryConditionValueIds

◆ MultiPhaseStateVarIds

Member Function Documentation

◆ calcDerivedResults()

◆ fillElementData()

◆ fillFlowMatrix()

◆ fillStorageCompMatrix()

◆ fixedNodalDofsBc()

◆ fixedNodalForcesBc()

◆ physicsMetaDataMap()