diff --git a/applications/solvers/DNS/DNSSolversDoc.H b/applications/solvers/DNS/DNSSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..307be76cc596653af942b333275334f4540d434b --- /dev/null +++ b/applications/solvers/DNS/DNSSolversDoc.H @@ -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 grpDNSSolvers Direct Numerical Simulation solvers +@{ + \ingroup grpSolvers + This group contains Direct Numerical Simulation (DNS) solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/DNS/dnsFoam/dnsFoam.C b/applications/solvers/DNS/dnsFoam/dnsFoam.C index 38c5b7be8f042ec96344564dd73ae7e8b61a14f3..444874c82f963a41e26173ecc7fa6c83444f39ea 100644 --- a/applications/solvers/DNS/dnsFoam/dnsFoam.C +++ b/applications/solvers/DNS/dnsFoam/dnsFoam.C @@ -24,6 +24,9 @@ License Application dnsFoam +Group + grpDNSSolvers + Description Direct numerical simulation solver for boxes of isotropic turbulence diff --git a/applications/solvers/basic/basicSolversDoc.H b/applications/solvers/basic/basicSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..c8bb86db95e29c1c068c6d896a9bf4a8e8082f2f --- /dev/null +++ b/applications/solvers/basic/basicSolversDoc.H @@ -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 grpBasicSolvers Basic solvers +@{ + \ingroup grpSolvers + This group contains basic solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/basic/laplacianFoam/laplacianFoam.C b/applications/solvers/basic/laplacianFoam/laplacianFoam.C index 218d91ac447bca7da2114145d2627ccb0baebb99..846a4b00a032e4eb4140af22630e44fa152a26be 100644 --- a/applications/solvers/basic/laplacianFoam/laplacianFoam.C +++ b/applications/solvers/basic/laplacianFoam/laplacianFoam.C @@ -24,8 +24,30 @@ License Application laplacianFoam +Group + grpBasicSolvers + Description - Solves a simple Laplace equation, e.g. for thermal diffusion in a solid. + Laplace equation solver for a scalar quantity. + + \heading Solver details + The solver is applicable to, e.g. for thermal diffusion in a solid. The + equation is given by: + + \f[ + \ddt{T} = \div \left( D_T \grad T \right) + \f] + + Where: + \vartable + T | Scalar field which is solved for, e.g. temperature + D_T | Diffusion coefficient + \endvartable + + \heading Required fields + \plaintable + T | Scalar field which is solved for, e.g. temperature + \endplaintable \*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C b/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C index 2430732e6ddda9e72a704ae660b22ce6aad96d63..5db9981db673def85533582f0cf08a6fcdf97463 100644 --- a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C +++ b/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C @@ -24,8 +24,32 @@ License Application scalarTransportFoam +Group + grpBasicSolvers + Description - Solves a transport equation for a passive scalar + Passive scalar transport equation solver. + + \heading Solver details + The equation is given by: + + \f[ + \ddt{T} + \div \left(\vec{U} T\right) - \div \left(D_T \grad T \right) + = S_{T} + \f] + + Where: + \vartable + T | Passive scalar + D_T | Diffusion coefficient + S_T | Source + \endvartable + + \heading Required fields + \plaintable + T | Passive scalar + U | Velocity [m/s] + \endplaintable \*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/combustion/PDRFoam/PDRFoam.C b/applications/solvers/combustion/PDRFoam/PDRFoam.C index fa8518ba495f105c3159be9d482b22b892778a46..08e8283382093f87f1af1ba3ac60168f97cd9227 100644 --- a/applications/solvers/combustion/PDRFoam/PDRFoam.C +++ b/applications/solvers/combustion/PDRFoam/PDRFoam.C @@ -24,6 +24,9 @@ License Application PDRFoam +Group + grpCombustionSolvers + Description Solver for compressible premixed/partially-premixed combustion with turbulence modelling. @@ -54,16 +57,17 @@ Description regions containing blockages which cannot be resolved by the mesh. The fields used by this solver are: - - betav: Volume porosity - Lobs: Average diameter of obstacle in cell (m) - Aw: Obstacle surface area per unit volume (1/m) - CR: Drag tensor (1/m) - CT: Turbulence generation parameter (1/m) - Nv: Number of obstacles in cell per unit volume (m^-2) - nsv: Tensor whose diagonal indicates the number to substract from - Nv to get the number of obstacles crossing the flow in each - direction. + \plaintable + betav | Volume porosity + Lobs | Average diameter of obstacle in cell (m) + Aw | Obstacle surface area per unit volume (1/m) + CR | Drag tensor (1/m) + CT | Turbulence generation parameter (1/m) + Nv | Number of obstacles in cell per unit volume (m^-2) + nsv | Tensor whose diagonal indicates the number to substract from + | Nv to get the number of obstacles crossing the flow in each + | direction. + \endplaintable \*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C b/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C index d4cb0666e291710c3fbff6263735e5be53c31e31..4b2c35f3664c861833fb37c11f8c5dadc09f6718 100644 --- a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C +++ b/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C @@ -24,6 +24,9 @@ License Application XiFoam +Group + grpCombustionSolvers grpMovingMeshSolvers + Description Solver for compressible premixed/partially-premixed combustion with turbulence modelling. diff --git a/applications/solvers/combustion/XiFoam/XiFoam.C b/applications/solvers/combustion/XiFoam/XiFoam.C index 6090f923ca656495f3a70188b015ee6f331256a3..3b2c18f925742f74f1146721de2902c1715196a8 100644 --- a/applications/solvers/combustion/XiFoam/XiFoam.C +++ b/applications/solvers/combustion/XiFoam/XiFoam.C @@ -24,6 +24,9 @@ License Application XiFoam +Group + grpCombustionSolvers + Description Solver for compressible premixed/partially-premixed combustion with turbulence modelling. diff --git a/applications/solvers/combustion/chemFoam/chemFoam.C b/applications/solvers/combustion/chemFoam/chemFoam.C index a34555193328ed10434313e593b3742edcb5e571..cc94807a3947af4e6c9c6b712d53017117e0fa24 100644 --- a/applications/solvers/combustion/chemFoam/chemFoam.C +++ b/applications/solvers/combustion/chemFoam/chemFoam.C @@ -24,6 +24,9 @@ License Application chemFoam +Group + grpCombustionSolvers + Description Solver for chemistry problems - designed for use on single cell cases to provide comparison against diff --git a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C b/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C index e85010239b87bd9a07f4a5015a8110c47bd01001..77c07e98540887b63fc6bf922a0c5cc84c607225 100644 --- a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C +++ b/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C @@ -22,7 +22,10 @@ License along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. Application - engineFoam + coldEngineFoam + +Group + grpCombustionSolvers grpMovingMeshSolvers Description Solver for cold-flow in internal combustion engines. diff --git a/applications/solvers/combustion/combustionSolversDoc.H b/applications/solvers/combustion/combustionSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..bc68bdb7fefd4607ace55689d24a3e87ef412d70 --- /dev/null +++ b/applications/solvers/combustion/combustionSolversDoc.H @@ -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 grpCombustionSolvers Combustion solvers +@{ + \ingroup grpSolvers + This group contains combustion solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/combustion/engineFoam/engineFoam.C b/applications/solvers/combustion/engineFoam/engineFoam.C index 4602eac9976a2b592dfa401d8f5852fd77d47e4e..fc14f49da226f1b120f1925d5a86b4a476951031 100644 --- a/applications/solvers/combustion/engineFoam/engineFoam.C +++ b/applications/solvers/combustion/engineFoam/engineFoam.C @@ -24,6 +24,9 @@ License Application engineFoam +Group + grpCombustionSolvers + Description Solver for internal combustion engines. diff --git a/applications/solvers/combustion/fireFoam/fireFoam.C b/applications/solvers/combustion/fireFoam/fireFoam.C index 31ace4dda8301be3e9dd1421dd38ecbe064c2464..203b4d475e606ca4be02e773c1516fe133268eba 100644 --- a/applications/solvers/combustion/fireFoam/fireFoam.C +++ b/applications/solvers/combustion/fireFoam/fireFoam.C @@ -24,8 +24,11 @@ License Application fireFoam +Group + grpCombustionSolvers + Description - Transient PIMPLE solver for Fires and turbulent diffusion flames with + Transient PIMPLE solver for fires and turbulent diffusion flames with reacting Lagrangian parcels, surface film and pyrolysis modelling. \*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/combustion/reactingFoam/reactingFoam.C b/applications/solvers/combustion/reactingFoam/reactingFoam.C index 79deedb763fbefe580b7c0c54b6a65bbf9528861..793677b695bdc39e053e762f4115fc806826f2be 100644 --- a/applications/solvers/combustion/reactingFoam/reactingFoam.C +++ b/applications/solvers/combustion/reactingFoam/reactingFoam.C @@ -24,6 +24,9 @@ License Application reactingFoam +Group + grpCombustionSolvers + Description Solver for combustion with chemical reactions. diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C index e8645bb47c0b8a7d59c9c85d701a3b26e7a84727..3d854c03ef348d873bb13972c6f078f4169d09be 100644 --- a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C +++ b/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C @@ -24,6 +24,9 @@ License Application rhoReactingBuoyantFoam +Group + grpCombustionSolvers + Description Solver for combustion with chemical reactions using density based thermodynamics package, using enahanced buoyancy treatment. diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C index 6eb245028d0c5c07714b63d0fcb982c11f628d08..c9e349a2601fcac59c7744b2d2cc9b673e77d1ee 100644 --- a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C +++ b/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C @@ -24,6 +24,9 @@ License Application rhoReactingFoam +Group + grpCombustionSolvers + Description Solver for combustion with chemical reactions using density based thermodynamics package. diff --git a/applications/solvers/compressible/compressibleSolvers.H b/applications/solvers/compressible/compressibleSolvers.H new file mode 100644 index 0000000000000000000000000000000000000000..85ab71f517723fc670ef20b0fd0b6bc64ef5f43c --- /dev/null +++ b/applications/solvers/compressible/compressibleSolvers.H @@ -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 grpCompressibleSolvers Compressible flow solvers +@{ + \ingroup grpSolvers + This group contains compressible flow solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C index 38ffddc7796944d22bc2c0ff7c3365e52c37b71b..4bb65304bfc699c6835c633f0abce936e790ca2a 100644 --- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C +++ b/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C @@ -24,6 +24,9 @@ License Application rhoCentralDyMFoam +Group + grpCompressibleSolvers grpMovingMeshSolvers + Description Density-based compressible flow solver based on central-upwind schemes of Kurganov and Tadmor with support for mesh-motion and topology changes diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C index 4faed39f75b37de026aabc6ea406e39b197b7722..808962e0935463da09a458c2cf3a4e7353837c97 100644 --- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C +++ b/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C @@ -24,6 +24,9 @@ License Application rhoCentralFoam +Group + grpCompressibleSolvers + Description Density-based compressible flow solver based on central-upwind schemes of Kurganov and Tadmor diff --git a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C index 382d041fd956c3bdeb8b02ab887073fd7c5de45e..ddfab009b77d1afc8703ad34483a8a56f8785747 100644 --- a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C +++ b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C @@ -24,6 +24,9 @@ License Application rhoPimpleFoam +Group + grpCompressibleSolvers + Description Transient solver for laminar or turbulent flow of compressible fluids for HVAC and similar applications. diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C index a7482b3df148b4ae8c1c8a9ea086b35c5609c3b6..0e9fef5e26a871481e0c757f1c0fdff1ae466865 100644 --- a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C +++ b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C @@ -24,6 +24,9 @@ License Application rhoPorousSimpleFoam +Group + grpCompressibleSolvers + Description Steady-state solver for turbulent flow of compressible fluids with RANS turbulence modelling, implicit or explicit porosity treatment diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C index d554931e6280051d246eefd9b35ed0ff1c8d676c..7f0908689d93f2c48792c8609b226e3ce12d534f 100644 --- a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C +++ b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C @@ -24,6 +24,9 @@ License Application rhoSimpleFoam +Group + grpCompressibleSolvers + Description Steady-state SIMPLE solver for laminar or turbulent RANS flow of compressible fluids. diff --git a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C index c60a331b2d6e117c8873cf74765c6c4bdbb7cf9a..9fda46121184c6ce8e700a8cf5ea17c7e8a38f45 100644 --- a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C +++ b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C @@ -21,6 +21,9 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. +Group + grpCompressibleSolvers + Application sonicLiquidFoam diff --git a/applications/solvers/discreteMethods/discreteMethodsSolversDoc.H b/applications/solvers/discreteMethods/discreteMethodsSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..06c67407aa7fe91c57c12576c0516314bb408b45 --- /dev/null +++ b/applications/solvers/discreteMethods/discreteMethodsSolversDoc.H @@ -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 grpDiscreteMethodsSolvers Discrete method solvers +@{ + \ingroup grpSolvers + This group contains discrete method solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C index a5e0562155e53c2d9dcc92b5169dae7fc4831e82..edf3691fb4075fea8fd4a2275b369d680268f3a3 100644 --- a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C +++ b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C @@ -24,6 +24,9 @@ License Application dsmcFoam +Group + grpDiscreteMethodsSolvers + Description Direct simulation Monte Carlo (DSMC) solver for 3D, transient, multi- species flows diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C index 50c7f66085a36bc32ce72e1933a3c60a17ab4734..fa2b04f563b124fc4430d039eb4cb954ac9c2251 100644 --- a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C +++ b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C @@ -24,6 +24,9 @@ License Application mdEquilibrationFoam +Group + grpDiscreteMethodsSolvers + Description Equilibrates and/or preconditions molecular dynamics systems diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C index 68f6530c95f08e3b4f3624b37d7abfb503f490da..f06436c603f4f9163477cebae6cb183a72392765 100644 --- a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C +++ b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C @@ -24,6 +24,9 @@ License Application mdFoam +Group + grpDiscreteMethodsSolvers + Description Molecular dynamics solver for fluid dynamics diff --git a/applications/solvers/doc/solver.dox b/applications/solvers/doc/solver.dox new file mode 100644 index 0000000000000000000000000000000000000000..4c829de1624d52d0307283a1009276b5dacc06b3 --- /dev/null +++ b/applications/solvers/doc/solver.dox @@ -0,0 +1,44 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\page pageSolvers Solvers + +\section secSolvers Overview +The available solvers are grouped into the following categories: + - \ref grpBasicSolvers + - \ref grpCombustionSolvers + - \ref grpCompressibleSolvers + - \ref grpDiscreteMethodsSolvers + - \ref grpDNSSolvers + - \ref grpElectroMagneticsSolvers + - \ref grpFinancialSolvers + - \ref grpHeatTransferSolvers + - \ref grpIncompressibleSolvers + - \ref grpLagrangianSolvers + - \ref grpMultiphaseSolvers + - \ref grpStressAnalysisSolvers + + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/doc/solversDoc.H b/applications/solvers/doc/solversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..da58bc0ce33e8431dec1105e7c61bdeb62bbc3da --- /dev/null +++ b/applications/solvers/doc/solversDoc.H @@ -0,0 +1,37 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / 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 grpSolvers Solvers +@{ + This group contains solvers +@} + +\defgroup grpMovingMeshSolvers Moving mesh solvers +@{ + \ingroup grpSolvers + This group contains moving mesh solvers solvers +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/electromagnetics/electromagneticsSolversDoc.H b/applications/solvers/electromagnetics/electromagneticsSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..773733f5bb3581a55628764a721116bd1b6ec747 --- /dev/null +++ b/applications/solvers/electromagnetics/electromagneticsSolversDoc.H @@ -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 grpElectroMagneticsSolvers Electro-magnetics solvers +@{ + \ingroup grpSolvers + This group contains electro-magnetics solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C index 94cd1f0ca76d1b282f6e445c556bb2565d076f70..5c4a248df0a6f389351b0956feb56fbb7ff2e035 100644 --- a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C +++ b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C @@ -24,6 +24,9 @@ License Application electrostaticFoam +Group + grpElectroMagneticsSolvers + Description Solver for electrostatics. diff --git a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C index 1b7d4f4f948bee2a542e6162a0097f67bb5a0c64..6613d2f206ef088ebb14326de703adbe665d7d80 100644 --- a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C +++ b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C @@ -24,6 +24,9 @@ License Application magneticFoam +Group + grpElectroMagneticsSolvers + Description Solver for the magnetic field generated by permanent magnets. diff --git a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C index c9cb0242bd1393b17b1b7787ca9354e9a3d31be2..497e977e85a1bd60f1bd5ccd5cc16d5a58616c01 100644 --- a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C +++ b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C @@ -24,6 +24,9 @@ License Application mhdFoam +Group + grpElectroMagneticsSolvers + Description Solver for magnetohydrodynamics (MHD): incompressible, laminar flow of a conducting fluid under the influence of a magnetic field. diff --git a/applications/solvers/financial/financialFoam/financialFoam.C b/applications/solvers/financial/financialFoam/financialFoam.C index 16640d7ce7ed614dff3c54fa757e66facc89ac2c..2c912c7b93c58c0d380f23243922538760d22536 100644 --- a/applications/solvers/financial/financialFoam/financialFoam.C +++ b/applications/solvers/financial/financialFoam/financialFoam.C @@ -24,6 +24,9 @@ License Application financialFoam +Group + grpFinancialSolvers + Description Solves the Black-Scholes equation to price commodities. diff --git a/applications/solvers/financial/financialSolversDoc.H b/applications/solvers/financial/financialSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..02197d5e375bffdb67431385bdafafb1d9b40f50 --- /dev/null +++ b/applications/solvers/financial/financialSolversDoc.H @@ -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 grpFinancialSolvers Financial solvers +@{ + \ingroup grpSolvers + This group contains financial solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C index e71cd3febe2749ae45904b52d8af587d362c27b5..01477f9ed1d0e8aba206ad791b4ed35249cffd58 100644 --- a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C @@ -24,6 +24,9 @@ License Application buoyantBoussinesqPimpleFoam +Group + grpHeatTransferSolvers + Description Transient solver for buoyant, turbulent flow of incompressible fluids diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C index 6dff329d1fee1e941a94d3dc5ae1ec04a20b6f4a..ebe4bac86c33c42dd3346266e05888c448004f5c 100644 --- a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C @@ -24,6 +24,9 @@ License Application buoyantBoussinesqSimpleFoam +Group + grpHeatTransferSolvers + Description Steady-state solver for buoyant, turbulent flow of incompressible fluids diff --git a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C index cd254643b08b07f2055462014ca67dbeffebf8c3..42104ed54e53a57adf9b8d8a1c9e7dd1c5d65996 100644 --- a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C @@ -24,6 +24,9 @@ License Application buoyantPimpleFoam +Group + grpHeatTransferSolvers + Description Transient solver for buoyant, turbulent flow of compressible fluids for ventilation and heat-transfer. diff --git a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C index 403fb6fecd1bdd5eea1de8e7eea749fb9ee6cc7f..e6f5573e362af284de785eb07c4ca528f566b421 100644 --- a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C +++ b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C @@ -24,6 +24,9 @@ License Application buoyantSimpleFoam +Group + grpHeatTransferSolvers + Description Steady-state solver for buoyant, turbulent flow of compressible fluids, including radiation, for ventilation and heat-transfer. diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C index 7fe33fab37f69e9e55ca3e59a3673aea84e5fbf3..f00fb7fa05d2a442ac6a5def8024a173d80e546f 100644 --- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C +++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C @@ -24,6 +24,9 @@ License Application chtMultiRegionFoam +Group + grpHeatTransferSolvers + Description Combination of heatConductionFoam and buoyantFoam for conjugate heat transfer between solid regions and fluid regions. Both regions include diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C index 6c07dcbdfc42a7e5c3ccf87f74848f8086857b1f..dca30c63130e33b14957bca185371c2f816c1c23 100644 --- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C +++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C @@ -24,6 +24,9 @@ License Application chtMultiRegionSimpleFoam +Group + grpHeatTransferSolvers + Description Steady-state version of chtMultiRegionFoam diff --git a/applications/solvers/heatTransfer/heatTransferSolversDoc.H b/applications/solvers/heatTransfer/heatTransferSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..e85a79b97ce42159aff572a42297b68afd462446 --- /dev/null +++ b/applications/solvers/heatTransfer/heatTransferSolversDoc.H @@ -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 grpHeatTransferSolvers Heat transfer solvers +@{ + \ingroup grpSolvers + This group contains heat transfer solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C index a23ce288e3c5e6e4459a8a500eef1ec5f08e7b3b..01de835231360572df0c3dbcf3db8921783342dd 100644 --- a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C +++ b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C @@ -24,6 +24,9 @@ License Application thermoFoam +Group + grpHeatTransferSolvers + Description Evolves the thermodynamics on a frozen flow field diff --git a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C index f57f444121b7e21add1fcc5ae1fc3359b34aa3b7..d4eb1d72d16357c5026f5d901aad102f453ec7ef 100644 --- a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C +++ b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C @@ -24,6 +24,9 @@ License Application ajointShapeOptimizationFoam +Group + grpIncompressibleSolvers + Description Steady-state solver for incompressible, turbulent flow of non-Newtonian fluids with optimisation of duct shape by applying "blockage" in regions diff --git a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C index 4e35c5258f70a019fcfb3cec9fc6db8d013073bc..dc707b61dd12a662f726dff8738141e13c0cf9b4 100644 --- a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C +++ b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C @@ -24,6 +24,9 @@ License Application boundaryFoam +Group + grpIncompressibleSolvers + Description Steady-state solver for incompressible, 1D turbulent flow, typically to generate boundary layer conditions at an inlet, for use in a simulation. diff --git a/applications/solvers/incompressible/icoFoam/icoFoam.C b/applications/solvers/incompressible/icoFoam/icoFoam.C index 80e13faa8df406eb1ecb7ac1ad9919b6d43f3904..a7d0da4a8a2f5ba4731a2ac8cf2cae05e144efca 100644 --- a/applications/solvers/incompressible/icoFoam/icoFoam.C +++ b/applications/solvers/incompressible/icoFoam/icoFoam.C @@ -24,9 +24,40 @@ License Application icoFoam +Group + grpIncompressibleSolvers + Description Transient solver for incompressible, laminar flow of Newtonian fluids. + \heading Solver details + The solver uses the PISO algorithm to solve the continuity equation: + + \f[ + \div \vec{U} = 0 + \f] + + and momentum equation: + + \f[ + \ddt{\vec{U}} + + \div \left( \vec{U} \vec{U} \right) + - \div \left(\nu \grad \vec{U} \right) + = - \grad p + \f] + + Where: + \vartable + \vec{U} | Velocity + p | Pressure + \endvartable + + \heading Required fields + \plaintable + U | Velocity [m/s] + p | Kinematic pressure, p/rho [m2/s2] + \endplaintable + \*---------------------------------------------------------------------------*/ #include "fvCFD.H" diff --git a/applications/solvers/incompressible/incompressibleSolversDoc.H b/applications/solvers/incompressible/incompressibleSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..1ae50df0346eed555ae6cfe2e8d3961e9d08945a --- /dev/null +++ b/applications/solvers/incompressible/incompressibleSolversDoc.H @@ -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 grpIncompressibleSolvers Incompressible flow solvers +@{ + \ingroup grpSolvers + This group contains incompressible flow solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C index 9d3b567d3bffb4221d1fc3e979053d1a13264dc5..e1153a2772a855fa572340e5cd23f56e3af03161 100644 --- a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C +++ b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C @@ -24,6 +24,9 @@ License Application nonNewtonianIcoFoam +Group + grpIncompressibleSolvers + Description Transient solver for incompressible, laminar flow of non-Newtonian fluids. diff --git a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C index bfa86ea1d9b12dc3e0f65d1a29e3167c08a30c8d..eb5b2640694fb33ebe4407db19d27a353903d495 100644 --- a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C +++ b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C @@ -24,6 +24,9 @@ License Application SRFPimpleFoam +Group + grpIncompressibleSolvers + Description Large time-step transient solver for incompressible, flow in a single rotating frame using the PIMPLE (merged PISO-SIMPLE) algorithm. diff --git a/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C b/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C index cb01c03d63c4833b4ff83add869fe3095dd6580b..2ef700096922c3efb624c19b190bb261b18e4300 100644 --- a/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C +++ b/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C @@ -24,6 +24,9 @@ License Application pimpleDyMFoam.C +Group + grpIncompressibleSolvers grpMovingMeshSolvers + Description Transient solver for incompressible, flow of Newtonian fluids on a moving mesh using the PIMPLE (merged PISO-SIMPLE) algorithm. diff --git a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C index 72c6178d723b6f290f89caf797255c7166df9e9a..23cf9208bbe9b9f6d8911be320e4386c40c87602 100644 --- a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C +++ b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C @@ -24,14 +24,47 @@ License Application pimpleFoam +Group + grpIncompressibleSolvers + Description Large time-step transient solver for incompressible, flow using the PIMPLE (merged PISO-SIMPLE) algorithm. + \heading Solver details + The solver uses the PIMPLE (merged PISO-SIMPLE) algorithm to solve the + continuity equation: + + \f[ + \div \vec{U} = 0 + \f] + + and momentum equation: + + \f[ + \ddt{\vec{U}} + \div \left( \vec{U} \vec{U} \right) - \div \gvec{R} + = - \grad p + \vec{S}_U + \f] + + Where: + \vartable + \vec{U} | Velocity + p | Pressure + \vec{R} | Stress tensor + \vec{S}_U | Momentum source + \endvartable + Sub-models include: - turbulence modelling, i.e. laminar, RAS or LES - run-time selectable MRF and finite volume options, e.g. explicit porosity + \heading Required fields + \plaintable + U | Velocity [m/s] + p | Kinematic pressure, p/rho [m2/s2] + \<turbulence fields\> | As required by user selection + \endplaintable + \*---------------------------------------------------------------------------*/ #include "fvCFD.H" diff --git a/applications/solvers/incompressible/pisoFoam/pisoFoam.C b/applications/solvers/incompressible/pisoFoam/pisoFoam.C index 482b695cb943b60a0926638a47fd0e2992a5b660..b5a76a540a11ddcd5585fc12db7ca191e19f6321 100644 --- a/applications/solvers/incompressible/pisoFoam/pisoFoam.C +++ b/applications/solvers/incompressible/pisoFoam/pisoFoam.C @@ -24,13 +24,44 @@ License Application pisoFoam +Group + grpIncompressibleSolvers + Description Transient solver for incompressible flow. + \heading Solver details + The solver uses the PISO algorithm to solve the continuity equation: + + \f[ + \div \vec{U} = 0 + \f] + + and momentum equation: + + \f[ + \ddt{\vec{U}} + \div \left( \vec{U} \vec{U} \right) - \div \gvec{R} + = - \grad p + \f] + + Where: + \vartable + \vec{U} | Velocity + p | Pressure + \vec{R} | Stress tensor + \endvartable + Sub-models include: - turbulence modelling, i.e. laminar, RAS or LES - run-time selectable MRF and finite volume options, e.g. explicit porosity + \heading Required fields + \plaintable + U | Velocity [m/s] + p | Kinematic pressure, p/rho [m2/s2] + \<turbulence fields\> | As required by user selection + \endplaintable + \*---------------------------------------------------------------------------*/ #include "fvCFD.H" diff --git a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C index 47ec8ac9f63448dd1844c5db6311776cba23a95a..e7693a073edd0f184f3c347e653f7b40a295fd6b 100644 --- a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C +++ b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C @@ -24,6 +24,9 @@ License Application shallowWaterFoam +Group + grpIncompressibleSolvers + Description Transient solver for inviscid shallow-water equations with rotation. diff --git a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C index 97617bd925f979b50bc3bd93c30ec9fc36cb1fe1..43a3d41865854b05691af20f777f6e8eceb89514 100644 --- a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C @@ -24,6 +24,9 @@ License Application SRFSimpleFoam +Group + grpIncompressibleSolvers + Description Steady-state solver for incompressible, turbulent flow of non-Newtonian fluids in a single rotating frame. diff --git a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C index 3c9ef15c9547775ca42bae3d11f5dc576437d3cd..d086433012796b101b4c8cc01307732960e9a749 100644 --- a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C @@ -24,6 +24,9 @@ License Application porousSimpleFoam +Group + grpIncompressibleSolvers + Description Steady-state solver for incompressible, turbulent flow with implicit or explicit porosity treatment and support for multiple reference diff --git a/applications/solvers/incompressible/simpleFoam/simpleFoam.C b/applications/solvers/incompressible/simpleFoam/simpleFoam.C index eeb7bc1e345507d74f7e2f75fc796b02ef89edb7..5ea3fd50b13402e2f7fe896d52edd788f3f5a707 100644 --- a/applications/solvers/incompressible/simpleFoam/simpleFoam.C +++ b/applications/solvers/incompressible/simpleFoam/simpleFoam.C @@ -24,8 +24,40 @@ License Application simpleFoam +Group + grpIncompressibleSolvers + Description - Steady-state solver for incompressible, turbulent flow + Steady-state solver for incompressible flows with turbulence modelling. + + \heading Solver details + The solver uses the SIMPLE algorithm to solve the continuity equation: + + \f[ + \div \vec{U} = 0 + \f] + + and momentum equation: + + \f[ + \div \left( \vec{U} \vec{U} \right) - \div \gvec{R} + = - \grad p + \vec{S}_U + \f] + + Where: + \vartable + \vec{U} | Velocity + p | Pressure + \vec{R} | Stress tensor + \vec{S}_U | Momentum source + \endvartable + + \heading Required fields + \plaintable + U | Velocity [m/s] + p | Kinematic pressure, p/rho [m2/s2] + \<turbulence fields\> | As required by user selection + \endplaintable \*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C index 8999e03663d6e72a5995b25c07802faac561194e..22c16b4c80e4c88ed8aa0abc21b2b5c346fc5c30 100644 --- a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C +++ b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C @@ -24,6 +24,9 @@ License Application DPMFoam +Group + grpLagrangianSolvers + Description Transient solver for the coupled transport of a single kinematic particle cloud including the effect of the volume fraction of particles on the diff --git a/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C b/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C index 69048cf5a6feffbe10dbe7d94bd2baa658921dbc..4bb369f11b4d110580b059dfca2477d6d4437cc7 100644 --- a/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C +++ b/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C @@ -24,6 +24,9 @@ License Application MPPICFoam +Group + grpLagrangianSolvers + Description Transient solver for the coupled transport of a single kinematic particle cloud including the effect of the volume fraction of particles on the diff --git a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C index 3bfb2be7764b0fca8f2ac5d0184c7355a118b3fc..ab799c6496516305ca7599b3d901f540abb1f793 100644 --- a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C +++ b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C @@ -24,6 +24,9 @@ License Application coalChemistryFoam +Group + grpLagrangianSolvers + Description Transient solver for: - compressible, diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C index b355148a94c14d78df0c69978a44a063f401a2bf..0110832f2d7083a3430d60d1cfb083758f7456c1 100644 --- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C +++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C @@ -24,6 +24,9 @@ License Application uncoupledKinematicParcelDyMFoam +Group + grpLagrangianSolvers grpMovingMeshSolvers + Description Transient solver for the passive transport of a single kinematic particle cloud. diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C index befcb57d02b84a929d17a1dc8ec30d724c6f4aed..42273c1be5be07a2b4a825cd30aa213396098bf7 100644 --- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C +++ b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C @@ -24,6 +24,9 @@ License Application icoUncoupledKinematicParcelFoam +Group + grpLagrangianSolvers + Description Transient solver for the passive transport of a single kinematic particle cloud. diff --git a/applications/solvers/lagrangian/lagrangianSolversDoc.H b/applications/solvers/lagrangian/lagrangianSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..7eb88c4f3f94c391477b046da142de683e9b89e7 --- /dev/null +++ b/applications/solvers/lagrangian/lagrangianSolversDoc.H @@ -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 grpLagrangianSolvers Lagrangian solvers +@{ + \ingroup grpSolvers + This group contains Lagrangian solvers. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C b/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C index 98b33ff2854210022f10a2bf1ba55a230393350f..446fbb7b1a905a6924d7971a9d3d1ed2a1db3fa0 100644 --- a/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C +++ b/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C @@ -24,6 +24,9 @@ License Application reactingParcelFilmFoam +Group + grpLagrangianSolvers + Description Transient PIMPLE solver for compressible, laminar or turbulent flow with reacting Lagrangian parcels, and surface film modelling. diff --git a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C index b3e758df12fedefb9e3a5a4d9aef460dd0e68309..38f205d320650935e95673308aa7f3be32381796 100644 --- a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C +++ b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C @@ -24,6 +24,9 @@ License Application reactingParcelFoam +Group + grpLagrangianSolvers + Description Transient PIMPLE solver for compressible, laminar or turbulent flow with reacting multiphase Lagrangian parcels, including run-time selectable diff --git a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C index 9a49318c23eb75ecaa2812c1504f35a9c5977b96..d99253d077fd8a63065cf7253f98e21245c09592 100644 --- a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C +++ b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C @@ -24,6 +24,9 @@ License Application simpleReactingParcelFoam +Group + grpLagrangianSolvers + Description Steady state SIMPLE solver for compressible, laminar or turbulent flow with reacting multiphase Lagrangian parcels, including run-time selectable diff --git a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C index 38ac4e515b620bc90b86ee286b6bfb0646e1579b..5633a94bc0b838cd0a2feefa57180b5c0d2d4a57 100644 --- a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C +++ b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C @@ -24,6 +24,9 @@ License Application sprayDyMFoam +Group + grpLagrangianSolvers grpMovingMeshSolvers + Description Transient PIMPLE solver for compressible, laminar or turbulent flow with spray parcels and support for moving meshes. diff --git a/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C index 730d0f3fb4684fd1ac9c31dcb5a6699b321c4944..8c4efc355579b25f583220508ed9c3b7977a848d 100644 --- a/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C +++ b/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C @@ -24,6 +24,9 @@ License Application sprayEngineFoam +Group + grpLagrangianSolvers grpMovingMeshSolvers + Description Transient PIMPLE solver for compressible, laminar or turbulent engine flow swith spray parcels. diff --git a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C index 066ce82f68bbce7a0b0250c437d79a533127f8c3..8365bdfadec3f10ac5d961d6e6a755621c753faf 100644 --- a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C +++ b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C @@ -24,6 +24,9 @@ License Application sprayFoam +Group + grpLagrangianSolvers + Description Transient PIMPLE solver for compressible, laminar or turbulent flow with spray parcels. diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C index 6545c4d72b415ff258cdadbbcb6579ef8d1c9ea9..c6b592fb45fff1d37adb54eb5f96055fcc6ff5c6 100644 --- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C +++ b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C @@ -24,6 +24,9 @@ License Application uncoupledKinematicParcelFoam +Group + grpLagrangianSolvers + Description Transient solver for the passive transport of a single kinematic particle cloud. diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C index 189208de950a75c69ee914b77cd794ed78654b16..b578ed26c71e7a9aefc7f6ed48e3a16f6732a352 100644 --- a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C +++ b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C @@ -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. diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C index b521f5b9c6284ac07b9d5a59416d0153f85a6465..a71fc55e77d56703e1fcc3c4ed0e77ded7850bd6 100644 --- a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C +++ b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C @@ -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. diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C index 4e40addf2075540e121d582c39027dcfdc708c26..6930d6e9621f0cf21b79a6e4ff1ad3575d75d7c6 100644 --- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C +++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C @@ -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, diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C index 7736099eaa8cb9a01485dab0f1302a9b6b55822f..f7f44c16a9bb8d1db2513a076757ec5089d81ca7 100644 --- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C +++ b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C @@ -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. diff --git a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C index 4fd75efebff7b37a453a1e8d5dc7a8a98fc34183..bf84f44e3c527141a395f659de88b30f58915f0d 100644 --- a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C +++ b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C @@ -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. diff --git a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C index 3b88b1b9567d0ce9b251a33245c71a081a2f6293..45baf407b875ea0498282f688c4ca0e510d87cb1 100644 --- a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C +++ b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C @@ -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. diff --git a/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C b/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C index f30a1958069b45592391cd909cfc0556dbf10376..f5f61b4ac166afd0add387fea80d312d17d54b74 100644 --- a/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C +++ b/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C @@ -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, diff --git a/applications/solvers/multiphase/interFoam/interFoam.C b/applications/solvers/multiphase/interFoam/interFoam.C index 26f22af205ac20c423167f7768b639efec40408e..9f929e7f0b8b57fb8c7c1864769d39458cbf8ffd 100644 --- a/applications/solvers/multiphase/interFoam/interFoam.C +++ b/applications/solvers/multiphase/interFoam/interFoam.C @@ -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. diff --git a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C index 86a05e71f1aa4ab54c68d778cb09522bcf3712e7..8d64b4b5e019d3465f2c9f73b920d993faaeab7a 100644 --- a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C +++ b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C @@ -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. diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C index 93e4ebc0d11edd56cf131a6653d0ed70368b210d..95146cfbc506bfd0e6067ca0a83ae5204bb584dc 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C +++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C @@ -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 diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C index 8552126034e47501b610dc1415a18f47c08ff64c..6a91b597f67b56962fa70e653bce2bd9607466cb 100644 --- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C +++ b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C @@ -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 diff --git a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C index 8244f739d75777f2e07a71b566cf47b92de4600a..503f5f776db63d57a46779c9117dbbef636b0f07 100644 --- a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C +++ b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C @@ -24,6 +24,9 @@ License Application multiphaseEulerFoam +Group + grpMultiphaseSolvers + Description Solver for a system of many compressible fluid phases including heat-transfer. diff --git a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C index a04341c7ba9afcd1d891f6d6c3237c3e4ff62d84..c67b681d069e68ed56ef20ef8f974e3b55c171e6 100644 --- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C +++ b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C @@ -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. diff --git a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C index 0fb8ff1208f3ec7ab1ea1b089f12063c9d85cb69..38a7f00a40c62b1dc390e30bbc83f38a9e08adf0 100644 --- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C +++ b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C @@ -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. diff --git a/applications/solvers/multiphase/multiphaseSolversDoc.H b/applications/solvers/multiphase/multiphaseSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..1efb73e01bf4a8d678334bc0474866af5ebab59d --- /dev/null +++ b/applications/solvers/multiphase/multiphaseSolversDoc.H @@ -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. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C index b740ab2b9b174afedaa758e8f24d88e32189f52d..4c4aa314876d64a510c408344a679c2d13ff8adb 100644 --- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C +++ b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C @@ -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. diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C index b98bdb694d5c5a9481a806095e5b777268e2b4ec..3cef9aab1e033b15999e2b1fa7abb03caa395ee9 100644 --- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C +++ b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C @@ -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 diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C index cb90ee119626b6a0b83eec8c55bd857c294b3aa1..0271175a9e3f737fe99cba79064a51e02e543198 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C @@ -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 diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C index d18171a35d3549a38ab290efd70189c429069e85..29b28ae332c29ee7d542f4e5ef9a1ed7a382d42d 100644 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C @@ -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 diff --git a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C index d8519d6182ba154314733c4648cadbb272b05830..0a097dec83755f24251cb606eb57cc03bf64885c 100644 --- a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C +++ b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C @@ -24,6 +24,9 @@ License Application twoLiquidMixingFoam +Group + grpMultiphaseSolvers + Description Solver for mixing 2 incompressible fluids. diff --git a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C index 646b340c826cf06b280f8aae3d2c7b77a33a6126..e030446d1c71f1575adb7ed8db45d1de585b730a 100644 --- a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C +++ b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C @@ -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. diff --git a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C index e2c6c9433794ad6f0fd43bdac182ee6ead415492..129df9315d9aba2c36b574dca30a9704b0f77170 100644 --- a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C +++ b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C @@ -24,6 +24,9 @@ License Application solidDisplacementFoam +Group + grpStressAnalysisSolvers + Description Transient segregated finite-volume solver of linear-elastic, small-strain deformation of a solid body, with optional thermal diff --git a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C index 240593d81468da18b81068caccbb9e1dca0f0d05..4abd493e2f41e9d10dbf5b2d3913fd8ef27fd571 100644 --- a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C +++ b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C @@ -24,6 +24,9 @@ License Application solidEquilibriumDisplacementFoam +Group + grpStressAnalysisSolvers + Description Steady-state segregated finite-volume solver of linear-elastic, small-strain deformation of a solid body, with optional thermal diff --git a/applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H b/applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..fe3e73b0d4d34baf358f05d09bd4ee057f84bf07 --- /dev/null +++ b/applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H @@ -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 grpStressAnalysisSolvers Stress analysis solvers +@{ + \ingroup grpSolvers + This group contains stress analysis solvers. +@} + +\*---------------------------------------------------------------------------*/