mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: (further) Doxygen documentation updates for module support
This commit is contained in:
Andrew Heather
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::Euler
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
Euler ODE solver of order (0)1.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::EulerSI
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
Semi-implicit Euler ODE solver of order (0)1.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::ODESolver
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
Abstract base-class for ODE system solvers
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RKCK45
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
4/5th Order Cash-Karp Runge-Kutta ODE solver.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RKDP45
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
4/5th Order Dormand–Prince Runge-Kutta ODE solver.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RKF45
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
4/5th Order Runge-Kutta-Fehlberg ODE solver
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::Rosenbrock12
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
L-stable embedded Rosenbrock ODE solver of order (1)2.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::Rosenbrock23
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
L-stable embedded Rosenbrock ODE solver of order (2)3.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::Rosenbrock34
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
L-stable embedded Rosenbrock ODE solver of order (3)4.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::SIBS
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
Foam::SIBS
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::Trapezoid
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
Trapezoidal ODE solver of order (1)2.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::adaptiveSolver
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::rodas23
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
L-stable, stiffly-accurate embedded Rosenbrock ODE solver of order (2)3.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::rodas34
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
L-stable, stiffly-accurate embedded Rosenbrock ODE solver of order (3)4.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::seulex
|
||||
|
||||
Group
|
||||
grpODESolvers
|
||||
|
||||
Description
|
||||
An extrapolation-algorithm, based on the linearly implicit Euler method
|
||||
with step size control and order selection.
|
||||
|
||||
32
src/ODE/doc/ODEDoc.H
Normal file
32
src/ODE/doc/ODEDoc.H
Normal file
@ -0,0 +1,32 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / 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 grpODESolvers Ordinary Differential Equation (ODE) solvers
|
||||
@{
|
||||
\ingroup grpNumerics
|
||||
This group contains ODE solvers
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -23,13 +23,13 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpCmpTurbulenceBoundaryConditions Compressible Turbulence BCs
|
||||
\defgroup grpCmpTurbulenceBoundaryConditions Boundary conditions
|
||||
@{
|
||||
\ingroup grpCmpTurbulence
|
||||
This group contains compressible turbulence model boundary conditions
|
||||
@}
|
||||
|
||||
\defgroup grpCmpWallFunctions Compressible turbulence wall functions
|
||||
\defgroup grpCmpWallFunctions Wall functions
|
||||
@{
|
||||
\ingroup grpCmpTurbulenceBoundaryConditions
|
||||
This group contains compressible turbulence model wall functions
|
||||
|
||||
@ -23,13 +23,13 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpIcoTurbulenceBoundaryConditions Incompressible Turbulence BCs
|
||||
\defgroup grpIcoTurbulenceBoundaryConditions Boundary conditions
|
||||
@{
|
||||
\ingroup grpIcoTurbulence
|
||||
This group contains incompressible turbulence model boundary conditions
|
||||
@}
|
||||
|
||||
\defgroup grpIcoWallFunctions Incompressible turbulence wall functions
|
||||
\defgroup grpIcoWallFunctions Wall functions
|
||||
@{
|
||||
\ingroup grpIcoTurbulenceBoundaryConditions
|
||||
This group contains incompressible turbulence model wall functions
|
||||
|
||||
@ -23,7 +23,7 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpRASBoundaryConditions RAS boundary conditions
|
||||
\defgroup grpRASBoundaryConditions Boundary conditions
|
||||
@{
|
||||
\ingroup grpRASTurbulence
|
||||
This group contains RAS turbulence model boundary conditions
|
||||
|
||||
@ -23,7 +23,7 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpTurbulenceBoundaryConditions Turbulence boundary conditions
|
||||
\defgroup grpTurbulenceBoundaryConditions Boundary conditions
|
||||
@{
|
||||
\ingroup grpTurbulence
|
||||
This group contains turbulence model boundary conditions
|
||||
|
||||
@ -23,7 +23,7 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpTurbulence Turbulence
|
||||
\defgroup grpTurbulence Turbulence models
|
||||
@{
|
||||
This group contains turbulence models.
|
||||
@}
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::FSD
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
|
||||
Flame Surface Dennsity (FDS) combustion model.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::PaSR
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Partially stirred reactor combustion model. The model calculates a finite
|
||||
rate, based on both turbulence and chemistry time scales. Depending on
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModel
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Base class for combustion models
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::diffusion
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Simple diffusion-based combustion model based on the principle mixed is
|
||||
burnt. Additional parameter C is used to distribute the heat release rate
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::diffusionMulticomponent
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
|
||||
Diffusion based turbulent combustion model for multicomponent species.
|
||||
|
||||
31
src/combustionModels/doc/combustionModelsDoc.H
Normal file
31
src/combustionModels/doc/combustionModelsDoc.H
Normal file
@ -0,0 +1,31 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / 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 grpCombustionModels Combustion models
|
||||
@{
|
||||
This group contains combustion models.
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::infinitelyFastChemistry
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Simple infinitely fast chemistry combustion model based on the principle
|
||||
mixed is burnt. Additional parameter C is used to distribute the heat
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::laminar
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Laminar combustion model.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::noCombustion
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Dummy combustion model for 'no combustion'
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::combustionModels::singleStepCombustion
|
||||
|
||||
Group
|
||||
grpCombustionModels
|
||||
|
||||
Description
|
||||
Base class for combustion models using singleStepReactingMixture.
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpBoundaryConditions Boundary Conditions
|
||||
\defgroup grpBoundaryConditions Boundary conditions
|
||||
@{
|
||||
This group contains OpenFOAM boundary condition types. All conditions
|
||||
are derived from the base Foam::fvPatchField class. Patch values are
|
||||
@ -38,38 +38,38 @@ License
|
||||
of the matrix solve, via a call to \<field\>.correctBoundaryConditions().
|
||||
@}
|
||||
|
||||
\defgroup grpConstraintBoundaryConditions Constraint boundary Conditions
|
||||
\defgroup grpConstraintBoundaryConditions Constraint
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains constraint boundary condition types. These conditions
|
||||
are mainly employed to reduced dimensioned cases.
|
||||
@}
|
||||
|
||||
\defgroup grpInletBoundaryConditions Inlet boundary Conditions
|
||||
\defgroup grpInletBoundaryConditions Inlet
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains inlet boundary condition types
|
||||
@}
|
||||
|
||||
\defgroup grpOutletBoundaryConditions Outlet boundary Conditions
|
||||
\defgroup grpOutletBoundaryConditions Outlet
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains outlet boundary condition types
|
||||
@}
|
||||
|
||||
\defgroup grpGenericBoundaryConditions Generic boundary Conditions
|
||||
\defgroup grpGenericBoundaryConditions Generic
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains generic boundary condition types
|
||||
@}
|
||||
|
||||
\defgroup grpCoupledBoundaryConditions Coupled boundary Conditions
|
||||
\defgroup grpCoupledBoundaryConditions Coupled
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains coupled boundary condition types
|
||||
@}
|
||||
|
||||
\defgroup grpWallBoundaryConditions Wall boundary Conditions
|
||||
\defgroup grpWallBoundaryConditions Wall
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains wall boundary condition types
|
||||
|
||||
37
src/fvMotionSolver/doc/motionSolversDoc.H
Normal file
37
src/fvMotionSolver/doc/motionSolversDoc.H
Normal 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.
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::displacementInterpolationMotionSolver
|
||||
|
||||
Group
|
||||
grpMeshMotionSolvers
|
||||
|
||||
Description
|
||||
Mesh motion solver for an fvMesh.
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -23,7 +23,7 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpLagrangianIntermediate Lagrangian particle modelling
|
||||
\defgroup grpLagrangianIntermediate Lagrangian particle models
|
||||
@{
|
||||
This group contains Lagrangian modelling available in the 'intermediate' library
|
||||
@}
|
||||
|
||||
@ -18,6 +18,9 @@ fluxSummary/fluxSummaryFunctionObject.C
|
||||
Lambda2/Lambda2.C
|
||||
Lambda2/Lambda2FunctionObject.C
|
||||
|
||||
mapFields/mapFields.C
|
||||
mapFields/mapFieldsFunctionObject.C
|
||||
|
||||
Peclet/Peclet.C
|
||||
Peclet/PecletFunctionObject.C
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::compositeBody
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
This specialized rigidBody holds the original body after it has been merged
|
||||
into a parent.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::cuboid
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
Specialization of rigidBody to construct a cuboid given the mass and
|
||||
lengths of the sides.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::jointBody
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::masslessBody
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::rigidBody
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::sphere
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
Specialization of rigidBody to construct a sphere given the mass and radius.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::subBody
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsBodies
|
||||
|
||||
Description
|
||||
This specialized rigidBody holds the original body after it has been merged
|
||||
into a master.
|
||||
|
||||
50
src/rigidBodyDynamics/doc/rigidBodyDynamicsDoc.H
Normal file
50
src/rigidBodyDynamics/doc/rigidBodyDynamicsDoc.H
Normal file
@ -0,0 +1,50 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / 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 grpRigidBodyDynamics Rigid body dynamics
|
||||
@{
|
||||
\ingroup grpMeshMotion
|
||||
This group contains rigid body dynamics models.
|
||||
@}
|
||||
|
||||
\defgroup grpRigidBodyDynamicsBodies Bodies
|
||||
@{
|
||||
\ingroup grpRigidBodyDynamics
|
||||
This group contains rigid body dynamics body models.
|
||||
@}
|
||||
|
||||
\defgroup grpRigidBodyDynamicsJoints Joints
|
||||
@{
|
||||
\ingroup grpRigidBodyDynamics
|
||||
This group contains rigid body dynamics joint models.
|
||||
@}
|
||||
|
||||
\defgroup grpRigidBodyDynamicsRestraints Restraints
|
||||
@{
|
||||
\ingroup grpRigidBodyDynamics
|
||||
This group contains rigid body dynamics restraint models.
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Pa
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation along the specified arbitrary axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Px
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation along the x-axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Pxyz
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation in the x/y/z directions.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Py
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation along the y-axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Pz
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation along the x-axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Ra
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Revolute joint for rotation about the specified arbitrary axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Rs
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Spherical joint for rotation about the x/y/z-axes using a quaternion
|
||||
(Euler parameters) to avoid gimble-lock.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Rx
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Revolute joint for rotation about the x-axis
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Rxyz
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Spherical joint for rotation about the x/y/z-axes using Euler-angles
|
||||
in the order x, y, z.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Ry
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Revolute joint for rotation about the y-axis
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Ryxz
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Spherical joint for rotation about the x/y/z-axes using Euler-angles
|
||||
in the order y, x, z.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Rz
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Revolute joint for rotation about the z-axis
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::Rzyx
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Spherical joint for rotation about the x/y/z-axes using Euler-angles
|
||||
in the order z, y, x.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::composite
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation along the specified arbitrary axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::floating
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Prismatic joint for translation along the specified arbitrary axis.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Namespace
|
||||
Foam::RBD::joints
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Namespace for rigid-body joints
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::joints::null
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsJoints
|
||||
|
||||
Description
|
||||
Null joint for the root-body.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::restraints::linearAxialAngularSpring
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsRestraints
|
||||
|
||||
Description
|
||||
Linear axial angular spring restraint.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::restraints::linearDamper
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsRestraints
|
||||
|
||||
Description
|
||||
Linear damper restraint. Operates in the local frame of the body.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::restraints::linearSpring
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsRestraints
|
||||
|
||||
Description
|
||||
Linear spring restraint.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::RBD::restraints::sphericalAngularDamper
|
||||
|
||||
Group
|
||||
grpRigidBodyDynamicsRestraints
|
||||
|
||||
Description
|
||||
Spherical angular damper restraint.
|
||||
Operates in the local frame of the body.
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::rigidBodyMeshMotion
|
||||
|
||||
Group
|
||||
grpMeshMotionSolvers
|
||||
|
||||
Description
|
||||
Rigid-body mesh motion solver for fvMesh.
|
||||
|
||||
|
||||
50
src/sixDoFRigidBodyMotion/doc/sixDofRigidBodyMotionDoc.H
Normal file
50
src/sixDoFRigidBodyMotion/doc/sixDofRigidBodyMotionDoc.H
Normal file
@ -0,0 +1,50 @@
|
||||
/*---------------------------------------------------------------------------*\
|
||||
========= |
|
||||
\\ / 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 grpSixDoFRigidBody Six Degree of Freedom (DoF)
|
||||
@{
|
||||
\ingroup grpMeshMotion
|
||||
This group contains six DoF models.
|
||||
@}
|
||||
|
||||
\defgroup grpSixDoFRigidBodySolvers Solvers
|
||||
@{
|
||||
\ingroup grpSixDoFRigidBody
|
||||
This group contains six DoF solvers.
|
||||
@}
|
||||
|
||||
\defgroup grpSixDoFRigidBodyConstraints Constraints
|
||||
@{
|
||||
\ingroup grpSixDoFRigidBody
|
||||
This group contains six DoF Constraints.
|
||||
@}
|
||||
|
||||
\defgroup grpSixDoFRigidBodyRestraints Restraints
|
||||
@{
|
||||
\ingroup grpSixDoFRigidBody
|
||||
This group contains six DoF Restraints.
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::sixDoFRigidBodyMotionSolver
|
||||
|
||||
Group
|
||||
grpMeshMotionSolvers
|
||||
|
||||
Description
|
||||
6-DoF solid-body mesh motion solver for an fvMesh.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::sixDoFSolvers::CrankNicolson
|
||||
|
||||
Group
|
||||
grpSixDoFRigidBodySolvers
|
||||
|
||||
Description
|
||||
Crank-Nicolson 2nd-order time-integrator for 6DoF solid-body motion.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::sixDoFSolvers::Newmark
|
||||
|
||||
Group
|
||||
grpSixDoFRigidBodySolvers
|
||||
|
||||
Description
|
||||
Newmark 2nd-order time-integrator for 6DoF solid-body motion.
|
||||
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::sixDoFSolver
|
||||
|
||||
Group
|
||||
grpSixDoFRigidBodySolvers
|
||||
|
||||
Description
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -24,6 +24,9 @@ License
|
||||
Class
|
||||
Foam::sixDoFSolvers::symplectic
|
||||
|
||||
Group
|
||||
grpSixDoFRigidBodySolvers
|
||||
|
||||
Description
|
||||
Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion.
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ License
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
\defgroup grpThermoBoundaryConditions Thermophysical boundary conditions
|
||||
\defgroup grpThermoBoundaryConditions Thermophysical
|
||||
@{
|
||||
\ingroup grpBoundaryConditions
|
||||
This group contains thermophysical model boundary conditions
|
||||
|
||||
@ -29,7 +29,7 @@ License
|
||||
This group contains radiation models
|
||||
@}
|
||||
|
||||
\defgroup grpRadiationSubModels Radiation sub-models
|
||||
\defgroup grpRadiationSubModels Sub-models
|
||||
@{
|
||||
\ingroup grpRadiationModels
|
||||
This group contains radiation sub-models
|
||||
|
||||
Reference in New Issue
Block a user