ENH: Solvers - updated group documentation

This commit is contained in:
Andrew Heather
2015-12-03 22:05:55 +00:00
parent 7e28de25e6
commit b594d73c65
93 changed files with 849 additions and 15 deletions

View File

@ -24,6 +24,9 @@ License
Application
cavitatingFoam
Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Transient cavitation code based on the homogeneous equilibrium model
from which the compressibility of the liquid/vapour "mixture" is obtained.

View File

@ -24,6 +24,9 @@ License
Application
cavitatingFoam
Group
grpMultiphaseSolvers
Description
Transient cavitation code based on the homogeneous equilibrium model
from which the compressibility of the liquid/vapour "mixture" is obtained.

View File

@ -24,6 +24,9 @@ License
Application
compressibleInterDyMFoam
Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,

View File

@ -24,6 +24,9 @@ License
Application
compressibleInterFoam
Group
grpMultiphaseSolvers
Description
Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.

View File

@ -24,6 +24,9 @@ License
Application
compressibleMultiphaseInterFoam
Group
grpMultiphaseSolvers
Description
Solver for n compressible, non-isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.

View File

@ -24,6 +24,9 @@ License
Application
driftFluxFoam
Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible fluids using the mixture approach with the
drift-flux approximation for relative motion of the phases.

View File

@ -24,6 +24,9 @@ License
Application
interDyMFoam
Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach,

View File

@ -24,6 +24,9 @@ License
Application
interFoam
Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids using a VOF
(volume of fluid) phase-fraction based interface capturing approach.

View File

@ -24,6 +24,9 @@ License
Application
interMixingFoam
Group
grpMultiphaseSolvers
Description
Solver for 3 incompressible fluids, two of which are miscible,
using a VOF method to capture the interface.

View File

@ -24,6 +24,9 @@ License
Application
interPhaseChangeDyMFoam
Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids with phase-change
(e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based

View File

@ -24,6 +24,9 @@ License
Application
interPhaseChangeFoam
Group
grpMultiphaseSolvers
Description
Solver for 2 incompressible, isothermal immiscible fluids with phase-change
(e.g. cavitation). Uses a VOF (volume of fluid) phase-fraction based

View File

@ -24,6 +24,9 @@ License
Application
multiphaseEulerFoam
Group
grpMultiphaseSolvers
Description
Solver for a system of many compressible fluid phases including
heat-transfer.

View File

@ -24,6 +24,9 @@ License
Application
multiphaseInterFoam
Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Solver for n incompressible fluids which captures the interfaces and
includes surface-tension and contact-angle effects for each phase.

View File

@ -24,6 +24,9 @@ License
Application
multiphaseInterFoam
Group
grpMultiphaseSolvers
Description
Solver for n incompressible fluids which captures the interfaces and
includes surface-tension and contact-angle effects for each phase.

View File

@ -0,0 +1,30 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup grpMultiphaseSolvers Multiphase solvers
@{
\ingroup grpSolvers
This group contains multiphase solvers.
@}
\*---------------------------------------------------------------------------*/

View File

@ -24,6 +24,9 @@ License
Application
potentialFreeSurfaceDyMFoam
Group
grpMultiphaseSolvers grpMovingMeshSolvers
Description
Incompressible Navier-Stokes solver with inclusion of a wave height field
to enable single-phase free-surface approximations.

View File

@ -24,6 +24,9 @@ License
Application
potentialFreeSurfaceFoam
Group
grpMultiphaseSolvers
Description
Incompressible Navier-Stokes solver with inclusion of a wave height field
to enable single-phase free-surface approximations

View File

@ -24,6 +24,9 @@ License
Application
reactingMultiphaseEulerFoam
Group
grpMultiphaseSolvers
Description
Solver for a system of any number of compressible fluid phases with a
common pressure, but otherwise separate properties. The type of phase model

View File

@ -24,6 +24,9 @@ License
Application
reactingTwoPhaseEulerFoam
Group
grpMultiphaseSolvers
Description
Solver for a system of 2 compressible fluid phases with a common pressure,
but otherwise separate properties. The type of phase model is run time

View File

@ -24,6 +24,9 @@ License
Application
twoLiquidMixingFoam
Group
grpMultiphaseSolvers
Description
Solver for mixing 2 incompressible fluids.

View File

@ -24,6 +24,9 @@ License
Application
twoPhaseEulerFoam
Group
grpMultiphaseSolvers
Description
Solver for a system of 2 compressible fluid phases with one phase
dispersed, e.g. gas bubbles in a liquid including heat-transfer.