zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: (further) Doxygen documentation updates for module support

Browse Source
This commit is contained in:
Andrew Heather
2016-06-27 20:34:19 +01:00
parent 4a0c74d292
commit efb39a8790
257 changed files with 1122 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
src/fvMotionSolver/doc/motionSolversDoc.H Normal file
View File

@ -0,0 +1,37 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
\\/ 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 grpMeshMotion Mesh motion
@{
This group contains Mesh motion models.
@}
\defgroup grpMeshMotionSolvers Solvers
@{
\ingroup grpMeshMotion
This group contains Mesh motion solvers.
@}
\*---------------------------------------------------------------------------*/

3
src/fvMotionSolver/fvMotionSolvers/componentDisplacement/componentLaplacian/displacementComponentLaplacianFvMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::displacementComponentLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the given component of the motion displacement.

3
src/fvMotionSolver/fvMotionSolvers/componentVelocity/componentLaplacian/velocityComponentLaplacianFvMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::velocityComponentLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the given component of the motion velocity.

3
src/fvMotionSolver/fvMotionSolvers/displacement/SBRStress/displacementSBRStressFvMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::displacementSBRStressFvMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
solid-body rotation stress equations for the motion displacement.

3
src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::displacementInterpolationMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh.

3
src/fvMotionSolver/fvMotionSolvers/displacement/laplacian/displacementLaplacianFvMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::displacementLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the motion displacement.

3
src/fvMotionSolver/fvMotionSolvers/displacement/layeredSolver/displacementLayeredMotionMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::displacementLayeredMotionMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an (multi-block) extruded fvMesh. Gets given the
structure of the mesh blocks and boundary conditions on these blocks.

3
src/fvMotionSolver/fvMotionSolvers/displacement/surfaceAlignedSBRStress/surfaceAlignedSBRStressFvMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::surfaceAlignedSBRStressFvMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
solid-body rotation stress equations for the motion displacement.

3
src/fvMotionSolver/fvMotionSolvers/velocity/laplacian/velocityLaplacianFvMotionSolver.H
View File

@ -24,6 +24,9 @@ License
Class
Foam::velocityLaplacianFvMotionSolver
Group
grpMeshMotionSolvers
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the motion velocity.