Commit a80d4d9b authored by andy's avatar andy
Browse files

ENH: doxygen documentation updates

parent c40bc965
......@@ -21,6 +21,8 @@ License
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\defgroup grpFunctionObjects Function objects
@{
This group contains function objects
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,6 +21,8 @@ License
You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\mainpage OpenFOAM&reg;: open source CFD
\section about About OpenFOAM
......@@ -34,4 +36,28 @@ License
turbulence and heat transfer, to solid dynamics and electromagnetics.
<a href="http://www.openfoam.org/features">More ...</a>
\section layout Code Layout
The OpenFOAM source code comprises of four main components:
- src:
the core OpenFOAM source code
- applications:
collections of library functionality wrapped up into applications,
such as solvers and utilities
- tutorials:
a suite of test cases that highlight a broad cross-section of
OpenFOAM's capabilities
- doc:
supporting documentation
\section usingTheCode Using the code
- \subpage pagePostProcessing
- \subpage pageBoundaryConditions
- \subpage grpIcoRASBoundaryConditions
\*---------------------------------------------------------------------------*/
......@@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::basicSymmetryFvPatchField
Group
grpConstraintBoundaryConditions
Description
A symmetry patch
SourceFiles
basicSymmetryFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef basicSymmetryFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::calculatedFvPatchField
Group
grpGenericBoundaryConditions
Description
This boundary condition is not designed to be evaluated; it is assmued
that the value is assigned via field assignment, and not via a call to
......@@ -46,8 +46,6 @@ Description
SourceFiles
calculatedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef calculatedFvPatchField_H
......
......@@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::coupledFvPatchField
Group
grpCoupledBoundaryConditions
Description
Abstract base class for coupled patches.
SourceFiles
coupledFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef coupledFvPatchField_H
......
......@@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::directionMixedFvPatchField
Group
grpGenericBoundaryConditions
Description
Base class for direction-mixed boundary conditions.
SourceFiles
directionMixedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef directionMixedFvPatchField_H
......
......@@ -21,26 +21,26 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::fixedGradientFvPatchField
Group
grpGenericBoundaryConditions
Description
This boundary condition supplies a fixed gradient condition, such that
the patch values are calculated using:
\f[
values = int + gradient/delta
x_p = x_c + \frac{\nabla(x)}{\Delta}
\f]
where
/vartable
values | patch values
int | internal field values
gradient | gradient (user-specified)
delta | inverse distance from patch face centre to cell centre
x_p | patch values
x_c | internal field values
\nabla(x)| gradient (user-specified)
\Delta | inverse distance from patch face centre to cell centre
/endvartable
/heading Patch usage
......@@ -62,8 +62,6 @@ Description
SourceFiles
fixedGradientFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef fixedGradientFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::fixedValueFvPatchField
Group
grpGenericBoundaryConditions
Description
This boundary condition supplies a fixed value constraint, and is the base
class for a number of other boundary conditions.
......@@ -50,8 +50,6 @@ Description
SourceFiles
fixedValueFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef fixedValueFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::mixedFvPatchField
Group
grpGenericBoundaryConditions
Description
This boundary condition provides a base class for 'mixed' type boundary
conditions, i.e. conditions that mix fixed value and patch-normal gradient
......@@ -35,7 +35,7 @@ Description
The respective contributions from each is determined by a weight field:
\f[
x_p = w*A + (1-w)*(x_c + B/delta)
x_p = w*A + (1-w)*(x_c + B/\Delta)
\f]
where
......@@ -45,7 +45,7 @@ Description
w | weight field, \c valueFraction_
A | fixed value, \c refValue_
B | patch normal gradient, \c refGrad_
delta | inverse distance from face centre to internal cell centre
\Delta| inverse distance from face centre to internal cell centre
/endvartable
\note
......@@ -58,8 +58,6 @@ SeeAlso
SourceFiles
mixedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef mixedFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::slicedFvPatchField
Group
grpGenericBoundaryConditions
Description
Specialization of fvPatchField which creates the underlying
fvPatchField as a slice of the given complete field.
......@@ -42,8 +42,6 @@ SeeAlso
SourceFiles
slicedFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef slicedFvPatchField_H
......
......@@ -21,20 +21,18 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::transformFvPatchField
Group
grpGenericBoundaryConditions
Description
Foam::transformFvPatchField
SourceFiles
transformFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef transformFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::zeroGradientFvPatchField
Group
grpGenericBoundaryConditions
Description
This boundary condition appies a zero-gradient condition from the patch
internal field onto the patch faces.
......@@ -43,7 +43,6 @@ Description
SourceFiles
zeroGradientFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::cyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition enforces a cyclic condition between a pair of
boundaries.
......@@ -49,8 +49,6 @@ Description
SourceFiles
cyclicFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef cyclicFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::cyclicAMIFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition enforces a cyclic condition between a pair of
boundaries, whereby communication between the patches is performed using
......@@ -53,8 +53,6 @@ SeeAlso
SourceFiles
cyclicAMIFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef cyclicAMIFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::cyclicSlipFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition is a light wrapper around the cyclicFvPatchField
condition, providing no new functionality.
......@@ -47,8 +47,6 @@ SeeAlso
SourceFiles
cyclicSlipFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef cyclicSlipFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::emptyFvPatchField
Group
grpConstraintBoundaryConditions
Description
This boundary condition provides an 'empty' condition for reduced
dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to
......@@ -46,8 +46,6 @@ Description
SourceFiles
emptyFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef emptyFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::jumpCyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition provides a base class for coupled-cyclic
conditions with a specified 'jump' (or offset) between the values
......@@ -37,8 +37,6 @@ SeeAlso
SourceFiles
jumpCyclicFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef jumpCyclicFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::nonuniformTransformCyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition enforces a cyclic condition between a pair of
boundaries, incorporating a non-uniform transformation.
......@@ -37,8 +37,6 @@ SourceFiles
nonuniformTransformCyclicFvPatchFields.C
nonuniformTransformCyclicFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/
#ifndef nonuniformTransformCyclicFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::processorFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition enables processor communication across patches.
......@@ -43,8 +43,6 @@ Description
SourceFiles
processorFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef processorFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::processorCyclicFvPatchField
Group
grpCoupledBoundaryConditions
Description
This boundary condition enables processor communication across cyclic
patches.
......@@ -50,8 +50,6 @@ SourceFiles
processorCyclicFvPatchFields.C
processorCyclicFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/
#ifndef processorCyclicFvPatchField_H
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::symmetryFvPatchField
Group
grpConstraintBoundaryConditions
Description
This boundary condition enforces a symmetry constraint
......@@ -45,7 +45,6 @@ SourceFiles
symmetryFvPatchFields.C
symmetryFvPatchFields.H
symmetryFvPatchFieldsFwd.H
@}
\*---------------------------------------------------------------------------*/
......
......@@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup grpBoundaryConditions
@{
Class
Foam::wedgeFvPatchField
Group
grpConstraintBoundaryConditions
Description