StgFEM Component Codex
This is a list of components available in StgFEM.
AdvDiffMulticorrector
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/AdvectionDiffusion/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
An explicit method to solve the equations set up in the SU/PG formulation. See Brooks and Hughes, Section 4.2, pp. 225f
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| gamma | Double | 0.5 | Factor used to calculate generalised mass matrix. If  is 1/2, this is the trapezoidal rule. |
| multiCorrectorIterations | UnsignedInt | 2 | The number of iterations of the algorithm. See Remark 2 in Brooks and Hughes, Section 4.2, p. 228 |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
AdvDiffResidualForceTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/AdvectionDiffusion/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
The weighted residual vector for the SU/PG method.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| UpwindXiFunction | String | "Exact" | Determines the function to calculate the upwind parameter. Options are 'DoublyAsymptoticAssumption', 'CriticalAssumption' and 'Exact'. See Brooks and Hughes, Section 3.3.1, pp. 213-214 |
| defaultDiffusivity | Double | 1.0 | If the diffusivity isn't specified per integration point, this is the diffusivity used everywhere. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The Velocity Field doing the advection. | VelocityField | |
| Variable | No | If the diffusivity varies per integration point, this is the variable to map the integration point to the diffusivity. | DiffusivityVariable |
AdvectionDiffusionSLE
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/AdvectionDiffusion/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
An implementation of Brooks and Hughes' SU/PG advection-diffusion algorithm.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| dim | UnsignedInt | 0 | How many dimensions we are working in (either 2 or 3). This parameter is taken form the root dictionary. |
| courantFactor | Double | 0.5 | A factor to determine the timestep. Between 0 and 1. See Brooks and Hughes, p. 227. Also: http://mathworld.wolfram.com/Courant-Friedrichs-LewyCondition.html |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | The field, refered to as  , to which the advection and diffusion is taking place. | PhiField | |
| ForceVector | True | The weighted residual vector. | Residual | |
| Stg_Component | True | The Lumped Mass Matrix. See Brooks and Hughes, p. 226 | MassMatrix |
BilinearElementType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
BilinearInnerElType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Three internal nodes with resulting shape functions being discontinuous between elements.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Biqudratic
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
C0Generator
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
C2Generator
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
CellRemesher
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/src/
Project Web:
http://www.stgermainproject.org/StgDomain.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
ConstantElementType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
DivergenceMatrixTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
ElementType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
Abstract parent class for the different element type implementations. Also provides generic element type functionality.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
ElementType_Register
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Energy_SLE
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/Energy/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| StiffnessMatrix | True | ... | StiffnessMatrix | |
| SolutionVector | True | ... | SolutionVector | |
| ForceVector | True | ... | ForceVector |
Energy_SLE_Solver
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/Energy/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
FeEquationNumber
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
FeMesh
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
FeSwarmVariable
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | No | ... | FeVariable |
FeVariable
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Mesh | True | ... | FEMesh | |
| DofLayout | True | ... | DofLayout | |
| VariableCondition | No | ... | IC | |
| VariableCondition | No | ... | BC | |
| LinkedDofInfo | No | ... | LinkedDofInfo |
FieldTest
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
Takes either a FeVariable or a Swarm and either a analytic solution plugin or a reference solution file as input and compares the numerical solution against the analytic or reference solution and determines both an element wise error field and a global error value.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| normaliseByReferenceSolution | Bool | True | Normalise the error field against the analytic or reference solution. |
| numericVariableName | String | "" | Textual name of the variable to be used in the case of a swarm based variable. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Mesh | True | Constant element mesh for storing the element-wise error field. | ConstantElementMesh | |
| Mesh | True | Mesh for which the reference solution FeVariable is to be built. | ReferenceMesh | |
| Swarm | True | Swarm for integration the value of the fields across an element. | IntegrationSwarm | |
| FeVariable | False | FeVariable for the numeric solution. | NumericVariable | |
| FeVariable | False | Swarm for the numeric solution. | NumericSwarm |
FiniteElementContext
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
Builds on the DomainContext to allow a FEM problem to be constructed and solved
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| limitTimeStepIncreaseRate | Bool | False | Determines whether the increase in Dt should be limited |
| maxTimeStepIncreasePercentage | Double | 10.0 | Sets a limit on the percentage increase in Dt per timestep (requires limitTimeStepIncreaseRate to be True) |
| saveCoordsWithFields | Bool | False | Determines whether coordinates are output with field values in checkpoint files |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
ForceTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| ForceVector | True | ... | ForceVector | |
| Swarm | True | ... | Swarm | |
| Stg_Component | No | ... | ExtraInfo |
ForceVector
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| dim | UnsignedInt | 0 | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
GradientStiffnessMatrixTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Inner2DGenerator
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Generates a mesh with nodes situated at points internal to the element.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Mesh | true | Eulerian mesh | elementMesh |
IsoviscousStressTensorTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| viscosity | Double | 1.0 ) | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
LaplacianStiffnessMatrixTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
LinearTriangleElementType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
LinkedDofInfo
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Mesh | True | ... | Mesh | |
| DofLayout | True | ... | DofLayout | |
| Stg_Shape | True | ... | shapeStr |
LumpedMassMatrixForceTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/AdvectionDiffusion/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Builds the Lumped Mass Matrix (as a vector) necessary for the SU/PG method
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Matrix
Organisation:
VPAC
Project:
StgFEM
Location:
StgFEM/SLE/LinearAlgebra/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
StGermain Framework. Copyright (C) 2003-2005 VPAC.
License:
The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html
Parent:
Children:
Description:
...
MatrixSolver
Organisation:
VPAC
Project:
StgFEM
Location:
StgFEM/SLE/LinearAlgebra/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
StGermain Framework. Copyright (C) 2003-2005 VPAC.
License:
The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html
Parent:
Children:
Description:
...
OperatorFeVariable
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Field variable which is generated by the application of an Operator to a single or pair of FeVariables.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| Operator | String | "" | Operator to be applied to the FeVariable(s), the textual name of which is supplied through the XML. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | Field Variable to which the Operator is to be applied. May also be applied to a pair of FeVariables supplied via a list in the case of a binary Operator. | FeVariable |
P1
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
P1Generator
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
PETScMatrix
Organisation:
VPAC
Project:
StgFEM
Location:
StgFEM/SLE/LinearAlgebra/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
StGermain Framework. Copyright (C) 2003-2005 VPAC.
License:
The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html
Parent:
Children:
Description:
...
PETScMatrixSolver
Organisation:
VPAC
Project:
StgFEM
Location:
StgFEM/SLE/LinearAlgebra/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
StGermain Framework. Copyright (C) 2003-2005 VPAC.
License:
The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html
Parent:
Children:
Description:
...
PETScShellMatrix
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | ... | FeVariable |
PETScVector
Organisation:
VPAC
Project:
StgFEM
Location:
StgFEM/SLE/LinearAlgebra/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
StGermain Framework. Copyright (C) 2003-2005 VPAC.
License:
The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html
Parent:
Children:
Description:
...
PressureGradForceTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
PressureGradMatrixTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
RegularRemesherCmpt
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/src/
Project Web:
http://www.stgermainproject.org/StgDomain.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
This is a wrapper component to allow the RegularRemesher class to be used
as a component. This will be changed in the near future to combine the two.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
SLE_Solver
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| statSolve | Bool | False | ... |
| statReps | Int | 0 | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
ShapeFeVariable
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Field variable to be defined over a particular sub domain defined by the Shape supplied.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| Shape | String | "" | Defines the geometric sub domain over which the FeVariable is to be applied. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
SolutionVector
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | ... | FeVariable |
StiffnessMatrix
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| dim | UnsignedInt | 0 | ... |
| isNonLinear | Bool | False | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | ... | RowVariable | |
| FeVariable | True | ... | ColumnVariable | |
| ForceVector | True | ... | RHS | |
| Stg_Component | No | ... | ApplicationDepInfo |
StiffnessMatrixTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| StiffnessMatrix | True | ... | StiffnessMatrix | |
| Swarm | True | ... | Swarm | |
| Stg_Component | No | ... | ExtraInfo |
Stokes_SLE
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/StokesFlow/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
This SLE define the Stokes system of equations given by the 2x2 block matrix
[ K G ]{u} = {f}
[ D C ]{p} = {h} ........................................ (1)
The param names used to identify each matrix in (1) within the Stokes_SLE are
provided below.
K: StressTensorMatrix
G: GradientMatrix
D: DivergenceMatrix
C: CompressibilityMatrix
u: VelocityVector
p: PressureVector
f: ForceVector
h: ContinuityForceVector:
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| StiffnessMatrix | True | Matrix which is discrete counter part of a tensor gradient. | StressTensorMatrix | |
| StiffnessMatrix | True | Matrix which is the discrete counter part of the gradient operator. | GradientMatrix | |
| StiffnessMatrix | No | Matrix which is the discrete counter part of the divergence operator. | DivergenceMatrix | |
| StiffnessMatrix | No | Matrix which is the discrete counter part of "some" operator applied to p. The form of the operator is application dependent. | CompressibilityMatrix | |
| SolutionVector | True | The discrete velocity vector. | VelocityVector | |
| SolutionVector | True | The discrete pressure vector. | PressureVector | |
| ForceVector | True | The discrete forcing term for the momentum equation. | ForceVector | |
| ForceVector | True | The discrete forcing term for the continuity equation. | ContinuityForceVector |
Stokes_SLE_PenaltySolver
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/StokesFlow/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Stokes_SLE_UzawaSolver
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/StokesFlow/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Solves the pressure Schur complement equation
[ G^T K^{-1} G - C ] p = G^T K^{-1} f - h ....................... (1)
via preconditioned Conjugate Gradient (PCG). The velocity u is incrementally updated
at the same time the pressure is updated. Generally S will contain a constant null
space consisting of the vector {1}. Prior to any PCG iterations, we check whether the
null space is present in S. If it is, at each iteration the null space is removed.
If we let,
f* = G^T K^{-1} f - h,
then we define the following stopping condition for PCG,
|r_k| < tolerance * |f*| ......................................... (2)
where r_k is the residual of (1) at the k^th iteration,
r_k = f* - S p_k.
Eqn (2) is the default stopping condition used. When (2) is satisified, convergence of PCG
is deemed to have occurred. Setting the parameter "useAbsoluteTolerance" (see below) to True
will cause the following stopping condition to be used
|r_k| < tolerance ................................................ (3)
The iterative method used to define the action of y = K^{-1} x is defined by the
parameter called "velocitySolver". By default this solver uses a tolerance, delta_K given by
delta_K = 0.1 * tolerance. When using petsc to define linear solvers, this default can be
changed via the usual petsc KSP command line arguements. Eg -ksp_rtol 1.0e-8.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| tolerance | double | 1.0e-5 | Specifies the tolerance to which equation (1) will be solved. |
| maxIterations | int | 1000 | The maximum allowable number of PCG iterations which may be performed per solve. |
| minIterations | int | 1 | The minimum allowable number of PCG iterations which may be performed per solve. |
| useAbsoluteTolerance | Bool | False | Selects the absolute tolerance stopping condition described above. |
| monitor | Bool | False | Selects to display the iteration number, current residual and accumlated CPU time during at each PCG iterate. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| StiffnessMatrix | No | The matrix define an approximation to S. This will be used to precondition Sp=f* in the PCG algorithm. | Preconditioner | |
| MatrixSolver | No | The solver used to define the action y = K^{-1} x. | velocitySolver |
StripRemesher
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/src/
Project Web:
http://www.stgermainproject.org/StgDomain.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
SystemLinearEquations
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/SystemSetup/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Stg_Component
Description:
This is an Abstract Class which manages a given system of linear equation. It provides the setting up, building and initialisation of the matricies and vectors which are specified in child classes of this component. The means by which this class does this is through adding build/assembly functions onto Entry Points it creates itself. These functions are kicked off as the first part of a linearExecute statement, which can be found here - the second part of the linearExecute statement is a solve step, which is defined in a child class and is referenced here via a function pointer. Also of interest in this component is the algorithmic flow of the solve step, i.e. linear or nonlinear.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| isNonLinear | Bool | False | Optional flag that enforces a nonlinear behavior of the solver. If the simulation requires nonlinear solves this flag should be automatically set to true. |
| nonLinearTolerance | Double | 0.01 | A relative tolerance to which a nonlinear solve is calculated to. |
| nonLinearMaxIterations | UnsignedInt | 500 | A maximum number of nonlinear solve iterations that will be performed each time step |
| killNonConvergent | Bool | True | An essential flag, which will kill the simulation if the solver does not appear to be converging after a time step |
| makeConvergenceFile | Bool | False | An optional flag to backup infos on convergence into a Convergence.dat file |
| nonLinearMinIterations | UnsignedInt | 1 | A minimum number of nonlinear solve iterations that will be performed each time step |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| SLE_Solver | No | Is an optional component in charge of Solver specifics. This SLE_Solver component takes the mathematical objects held/managed by this SystemLinearEquations class and executes them accordingly | ||
| FiniteElementContext | No | An optional component which is the global data structure used in the simulation. Used here incase information about the simulation data structures is required |
ThermalBuoyancyForceTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Assembly/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Temperature and Rayleigh number dependent force term for the Stokes equation.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| Ra | Double | 0.0 | Rayleigh number - if small then heat transfer is conductive, if large then heat transfer is convective. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FeVariable | True | Temperature field | TemperatureField |
TrilinearElementType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
TrilinearInnerElType
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
Four internal nodes, constituting a tetrahedron with resulting shape functions being discontinuous between elements.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Triquadratic
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/Discretisation/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2007 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
3D element with quadratic shape functions
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
UzawaPreconditionerTerm
Organisation:
VPAC
Project:
StgFEM
Location:
./StgFEM/SLE/ProvidedSystems/StokesFlow/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
Copyright (C) 2004-2005 VPAC.
License:
https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
Vector
Organisation:
VPAC
Project:
StgFEM
Location:
StgFEM/SLE/LinearAlgebra/src/
Project Web:
http://www.stgermainproject.org/StgFEM.html
Copyright:
StGermain Framework. Copyright (C) 2003-2005 VPAC.
License:
The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html
Parent:
Children:
Description:
...