Abstract class for Porous Media Finite Element classes. More...


Public Member Functions | |
Equa_Porous () | |
Default constructor. More... | |
virtual | ~Equa_Porous () |
Destructor. | |
virtual void | Mobility () |
Add mobility term to the 0-th order element matrix. | |
virtual void | Mass () |
Add porosity term to the 1-st order element matrix. | |
virtual void | BodyRHS (const Vect< real_t > &bf, int opt=GLOBAL_ARRAY) |
Add source right-hand side term to right-hand side. More... | |
virtual void | BoundaryRHS (const Vect< real_t > &sf, int opt=GLOBAL_ARRAY) |
Add boundary right-hand side term to right-hand side. More... | |
void | build () |
Build the linear system of equations. More... | |
void | build (TimeStepping &s) |
Build the linear system of equations. More... | |
void | build (EigenProblemSolver &e) |
Build the linear system for an eigenvalue problem. More... | |
int | run () |
Run the equation. More... | |
void | Mu (const string &exp) |
Set viscosity given by an algebraic expression. | |
void | updateBC (const Element &el, const Vect< T_ > &bc) |
Update Right-Hand side by taking into account essential boundary conditions. More... | |
void | updateBC (const Vect< T_ > &bc) |
Update Right-Hand side by taking into account essential boundary conditions. More... | |
void | DiagBC (int dof_type=NODE_DOF, int dof=0) |
Update element matrix to impose bc by diagonalization technique. More... | |
void | LocalNodeVector (Vect< T_ > &b) |
Localize Element Vector from a Vect instance. More... | |
void | ElementNodeVector (const Vect< T_ > &b, LocalVect< T_, NEE_ > &be) |
Localize Element Vector from a Vect instance. More... | |
void | ElementNodeVector (const Vect< T_ > &b, LocalVect< T_, NEN_ > &be, int dof) |
Localize Element Vector from a Vect instance. More... | |
void | ElementNodeVectorSingleDOF (const Vect< T_ > &b, LocalVect< T_, NEN_ > &be) |
Localize Element Vector from a Vect instance. More... | |
void | ElementSideVector (const Vect< T_ > &b, LocalVect< T_, NSE_ > &be) |
Localize Element Vector from a Vect instance. More... | |
void | ElementVector (const Vect< T_ > &b, int dof_type=NODE_FIELD, int flag=0) |
Localize Element Vector. More... | |
void | SideVector (const Vect< T_ > &b) |
Localize Side Vector. More... | |
void | ElementNodeCoordinates () |
Localize coordinates of element nodes. More... | |
void | SideNodeCoordinates () |
Localize coordinates of side nodes. More... | |
void | ElementAssembly (Matrix< T_ > *A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (PETScMatrix< T_ > &A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (PETScVect< T_ > &b) |
Assemble element right-hand side vector into global one. More... | |
void | ElementAssembly (BMatrix< T_ > &A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (SkSMatrix< T_ > &A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (SkMatrix< T_ > &A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (SpMatrix< T_ > &A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (TrMatrix< T_ > &A) |
Assemble element matrix into global one. More... | |
void | ElementAssembly (Vect< T_ > &v) |
Assemble element vector into global one. More... | |
void | SideAssembly (PETScMatrix< T_ > &A) |
Assemble side matrix into global one. More... | |
void | SideAssembly (PETScVect< T_ > &b) |
Assemble side right-hand side vector into global one. More... | |
void | SideAssembly (Matrix< T_ > *A) |
Assemble side (edge or face) matrix into global one. More... | |
void | SideAssembly (SkSMatrix< T_ > &A) |
Assemble side (edge or face) matrix into global one. More... | |
void | SideAssembly (SkMatrix< T_ > &A) |
Assemble side (edge or face) matrix into global one. More... | |
void | SideAssembly (SpMatrix< T_ > &A) |
Assemble side (edge or face) matrix into global one. More... | |
void | SideAssembly (Vect< T_ > &v) |
Assemble side (edge or face) vector into global one. More... | |
void | DGElementAssembly (Matrix< T_ > *A) |
Assemble element matrix into global one for the Discontinuous Galerkin approximation. More... | |
void | DGElementAssembly (SkSMatrix< T_ > &A) |
Assemble element matrix into global one for the Discontinuous Galerkin approximation. More... | |
void | DGElementAssembly (SkMatrix< T_ > &A) |
Assemble element matrix into global one for the Discontinuous Galerkin approximation. More... | |
void | DGElementAssembly (SpMatrix< T_ > &A) |
Assemble element matrix into global one for the Discontinuous Galerkin approximation. More... | |
void | DGElementAssembly (TrMatrix< T_ > &A) |
Assemble element matrix into global one for the Discontinuous Galerkin approximation. More... | |
void | AxbAssembly (const Element &el, const Vect< T_ > &x, Vect< T_ > &b) |
Assemble product of element matrix by element vector into global vector. More... | |
void | AxbAssembly (const Side &sd, const Vect< T_ > &x, Vect< T_ > &b) |
Assemble product of side matrix by side vector into global vector. More... | |
size_t | getNbNodes () const |
Return number of element nodes. | |
size_t | getNbEq () const |
Return number of element equations. | |
void | setInitialSolution (const Vect< T_ > &u) |
Set initial solution (previous time step) | |
real_t | setMaterialProperty (const string &exp, const string &prop) |
Define a material property by an algebraic expression. More... | |
void | setMesh (Mesh &m) |
Define mesh and renumber DOFs after removing imposed ones. | |
Mesh & | getMesh () const |
Return reference to Mesh instance. More... | |
LinearSolver< T_ > & | getLinearSolver () |
Return reference to linear solver instance. | |
void | setSolver (Iteration ls, Preconditioner pc=IDENT_PREC) |
Choose solver for the linear system. More... | |
int | SolveLinearSystem (Matrix< T_ > *A, Vect< T_ > &b, Vect< T_ > &x) |
Solve the linear system. More... | |
Public Attributes | |
LocalMatrix< T_, NEE_, NEE_ > | eMat |
LocalMatrix instance containing local matrix associated to current element. | |
LocalMatrix< T_, NSE_, NSE_ > | sMat |
LocalMatrix instance containing local matrix associated to current side. | |
LocalVect< T_, NEE_ > | ePrev |
LocalVect instance containing local vector associated to current element. More... | |
LocalVect< T_, NEE_ > | eRHS |
LocalVect instance containing local right-hand side vector associated to current element. | |
LocalVect< T_, NEE_ > | eRes |
LocalVect instance containing local residual vector associated to current element. | |
LocalVect< T_, NSE_ > | sRHS |
LocalVect instance containing local right-hand side vector associated to current side. | |
Protected Member Functions | |
void | setMaterial () |
Set material properties. | |
void | Init (const Element *el) |
Set element arrays to zero. | |
void | Init (const Side *sd) |
Set side arrays to zero. | |
Detailed Description
template<class T_, size_t NEN_, size_t NEE_, size_t NSN_, size_t NSE_>
class OFELI::Equa_Porous< T_, NEN_, NEE_, NSN_, NSE_ >
Abstract class for Porous Media Finite Element classes.
- Template Parameters
-
<T_> data type (real_t, float, ...) <NEN> Number of element nodes <NEE_> Number of element equations <NSN_> Number of side nodes <NSE_> Number of side equations
Constructor & Destructor Documentation
Equa_Porous | ( | ) |
Default constructor.
Constructs an empty equation.
Member Function Documentation
|
virtual |
Add source right-hand side term to right-hand side.
- Parameters
-
[in] bf Vector containing source at element nodes. [in] opt Vector is local ( LOCAL_ARRAY
) with size3
or global (GLOBAL_ARRAY
) with size = Number of nodes [Default:GLOBAL_ARRAY
].
Reimplemented in WaterPorous2D.
|
virtual |
Add boundary right-hand side term to right-hand side.
- Parameters
-
[in] sf Vector containing source at side nodes. [in] opt Vector is local ( LOCAL_ARRAY
) with size3
or global (GLOBAL_ARRAY
) with size = Number of nodes [Default:GLOBAL_ARRAY
].
Reimplemented in WaterPorous2D.
void build | ( | ) |
Build the linear system of equations.
Before using this function, one must have properly selected appropriate options for:
- The choice of a steady state or transient analysis. By default, the analysis is stationary
- In the case of transient analysis, the choice of a time integration scheme and a lumped or consistent capacity matrix. If transient analysis is chosen, the lumped capacity matrix option is chosen by default, and the implicit Euler scheme is used by default for time integration.
void build | ( | TimeStepping & | s | ) |
Build the linear system of equations.
Before using this function, one must have properly selected appropriate options for:
- The choice of a steady state or transient analysis. By default, the analysis is stationary
- In the case of transient analysis, the choice of a time integration scheme. If transient analysis is chosen, the implicit Euler scheme is used by default for time integration.
- Parameters
-
[in] s Reference to used TimeStepping instance
void build | ( | EigenProblemSolver & | e | ) |
Build the linear system for an eigenvalue problem.
- Parameters
-
[in] e Reference to used EigenProblemSolver instance
int run | ( | ) |
Run the equation.
If the analysis (see function setAnalysis) is STEADY_STATE
, then the function solves the stationary equation.
If the analysis is TRANSIENT
, then the function performs time stepping until the final time is reached.
Update Right-Hand side by taking into account essential boundary conditions.
- Parameters
-
[in] el Reference to current element instance [in] bc Vector that contains imposed values at all DOFs
|
inherited |
Update Right-Hand side by taking into account essential boundary conditions.
- Parameters
-
[in] bc Vector that contains imposed values at all DOFs
- Remarks
- The current element is pointed by
_theElement
|
inherited |
Update element matrix to impose bc by diagonalization technique.
- Parameters
-
[in] dof_type DOF type option. To choose among the enumerated values: -
NODE_FIELD
, DOFs are supported by nodes [Default] -
ELEMENT_FIELD
, DOFs are supported by elements -
SIDE_FIELD
, DOFs are supported by sides
[in] dof DOF setting: -
= 0
, All DOFs are taken into account [Default] -
!= 0
, Only DOF No.dof
is handled in the system
-
|
inherited |
|
inherited |
Localize Element Vector.
- Parameters
-
[in] b Global vector to be localized [in] dof_type DOF type option. To choose among the enumerated values: -
NODE_FIELD
, DOFs are supported by nodes [Default] -
ELEMENT_FIELD
, DOFs are supported by elements -
SIDE_FIELD
, DOFs are supported by sides
[in] flag Option to set: -
= 0
, All DOFs are taken into account [Default] -
!= 0
, Only DOF numberdof
is handled in the system
ePrev
. -
|
inherited |
Localize Side Vector.
- Parameters
-
[in] b Global vector to be localized -
NODE_FIELD
, DOFs are supported by nodes [ default ] -
ELEMENT_FIELD
, DOFs are supported by elements -
SIDE_FIELD
, DOFs are supported by sides
ePrev
. -
|
inherited |
Localize coordinates of element nodes.
Coordinates are stored in array _x[0], _x[1], ...
which are instances of class Point<real_t>
- Remarks
- This member function uses the Side pointer
_theSide
|
inherited |
Localize coordinates of side nodes.
Coordinates are stored in array _x[0], _x[1], ...
which are instances of class Point<real_t>
- Remarks
- This member function uses the Element pointer
_theElement
|
inherited |
|
inherited |
Assemble element matrix into global one.
- Parameters
-
A Reference to global matrix
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element right-hand side vector into global one.
- Parameters
-
b Reference to global right-hand side vector
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one.
- Parameters
-
A Global matrix stored as a BMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one.
- Parameters
-
A Global matrix stored as an SkSMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one.
- Parameters
-
[in] A Global matrix stored as an SkMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one.
- Parameters
-
[in] A Global matrix stored as an SpMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one.
- Parameters
-
[in] A Global matrix stored as an TrMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element vector into global one.
- Parameters
-
[in] v Global vector (Vect instance)
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble side matrix into global one.
- Parameters
-
A Reference to global matrix
- Warning
- The side pointer is given by the global variable
theSide
|
inherited |
Assemble side right-hand side vector into global one.
- Parameters
-
b Reference to global right-hand side vector
- Warning
- The side pointer is given by the global variable
theSide
|
inherited |
|
inherited |
Assemble side (edge or face) matrix into global one.
- Parameters
-
[in] A Global matrix stored as an SkSMatrix instance
- Warning
- The side pointer is given by the global variable
theSide
|
inherited |
Assemble side (edge or face) matrix into global one.
- Parameters
-
[in] A Global matrix stored as an SkMatrix instance
- Warning
- The side pointer is given by the global variable
theSide
|
inherited |
Assemble side (edge or face) matrix into global one.
- Parameters
-
[in] A Global matrix stored as an SpMatrix instance
- Warning
- The side pointer is given by the global variable
theSide
|
inherited |
Assemble side (edge or face) vector into global one.
- Parameters
-
[in] v Global vector (Vect instance)
- Warning
- The side pointer is given by the global variable
theSide
|
inherited |
|
inherited |
Assemble element matrix into global one for the Discontinuous Galerkin approximation.
- Parameters
-
A Global matrix stored as an SkSMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one for the Discontinuous Galerkin approximation.
- Parameters
-
[in] A Global matrix stored as an SkMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one for the Discontinuous Galerkin approximation.
- Parameters
-
[in] A Global matrix stored as an SpMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Assemble element matrix into global one for the Discontinuous Galerkin approximation.
- Parameters
-
[in] A Global matrix stored as an TrMatrix instance
- Warning
- The element pointer is given by the global variable
theElement
|
inherited |
Define a material property by an algebraic expression.
- Parameters
-
[in] exp Algebraic expression [in] prop Property name
- Returns
- Return value in expression evaluation:
-
=0
, Normal evaluation -
!=0
, An error message is displayed
-
|
inherited |
|
inherited |
Choose solver for the linear system.
- Parameters
-
[in] ls Solver of the linear system. To choose among the enumerated values: DIRECT_SOLVER
,CG_SOLVER
,GMRES_SOLVER
-
DIRECT_SOLVER
, Use a facorization solver [default] -
CG_SOLVER
, Conjugate Gradient iterative solver -
CGS_SOLVER
, Squared Conjugate Gradient iterative solver -
BICG_SOLVER
, BiConjugate Gradient iterative solver -
BICG_STAB_SOLVER
, BiConjugate Gradient Stabilized iterative solver -
GMRES_SOLVER
, GMRES iterative solver -
QMR_SOLVER
, QMR iterative solver
[in] pc Preconditioner to associate to the iterative solver. If the direct solver was chosen for the first argument this argument is not used. Otherwise choose among the enumerated values: -
IDENT_PREC
, Identity preconditioner (no preconditioning [default]) -
DIAG_PREC
, Diagonal preconditioner -
ILU_PREC
, Incomplete LU factorization preconditioner
-
Solve the linear system.
- Parameters
-
[in] A Pointer to matrix of the system (Instance of class SpMatrix) [in] b Vector containing right-hand side [in,out] x Vector containing initial guess of solution on input, actual solution on output