zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: Updated for Doxygen 1.11.0

Browse Source
This commit is contained in:
Henry Weller
2024-07-06 14:10:15 +01:00
parent 5babe5c67c
commit 041b21a95e
28 changed files with 85 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/modules/multiphaseEuler/populationBalance/coalescenceModels/AdachiStuartFokkink/AdachiStuartFokkink.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2022-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2022-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -29,7 +29,7 @@ Description
Applicable when particles are smaller than the Kolmogorov length scale.
The coalescence rate is calculated by
f\[
\f[
\frac{4}{3}\left(\frac{3\pi}{10}\right)^{0.5}
\left(\frac{\epsilon}{\nu}\right)^{0.5}(d_i+d_j)^3
\f]

2
applications/utilities/miscellaneous/foamDictionary/foamDictionary.C
View File

@ -92,7 +92,7 @@ Usage
otherwise to standard output
- \par -includes
List the \c #include and \c #includeIfPresent files to standard output
List the \c \#include and \c \#includeIfPresent files to standard output
- \par -output
Path name of the output dictionary, defaults to the input dictionary

4
doc/Doxygen/Doxyfile
View File

@ -1624,7 +1624,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
@ -2334,7 +2334,7 @@ PLANTUML_INCLUDE_PATH =
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
DOT_GRAPH_MAX_NODES = 200
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the

8
src/OpenFOAM/db/dictionary/functionEntries/calcIncludeEntry/calcIncludeEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2023-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,9 +25,9 @@ Class
Foam::functionEntries::calcIncludeEntry
Description
Specify an include file for #calc, expects a single string to follow.
Specify an include file for \#calc, expects a single string to follow.
For example if functions from transform.H are used in the #calc expression
For example if functions from transform.H are used in the \#calc expression
\verbatim
angleOfAttack 5; // degs
@ -92,7 +92,7 @@ public:
//- Execute the functionEntry in a sub-dict context
static bool execute(dictionary& parentDict, Istream&);
//- Reset the cache of #calc include file names
//- Reset the cache of \#calc include file names
static void clear();
//- Add the cached include file names to the codeInclude entry

4
src/OpenFOAM/db/dictionary/functionEntries/ifeqEntry/ifeqEntry.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2018-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -56,7 +56,7 @@ Description
- the comparison is a string comparison for any word/string/variable,
integer comparison for two integers and floating point comparison for
any floating point number.
- parsing of (non)matching \c #else, \c #endif is not very sophisticated
- parsing of (non)matching \c \#else, \c \#endif is not very sophisticated
See also
Foam::functionEntries::ifEntry

2
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -32,8 +32,6 @@ Description
field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c -postProcess command-line option.
\subsection secFunctionObjects Using functionObjects
functionObjects are selected by entries in the $FOAM_CASE/system/functions
dictionary e.g. to select the \c functionObjectType functionObject the
following entry would be specified:

4
src/OpenFOAM/db/typeInfo/typeInfo.H
View File

@ -21,8 +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/>.
Typedef
Foam::typeInfo
InNamespace
Foam
Description
Basic run-time type information using word as the type's name.

8
src/OpenFOAM/fields/Fields/symmTransformField/symmTransformField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,11 +21,11 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::symmTransformField
InNamespace
Foam
Description
Spatial transformation functions for primitive fields.
Spatial transformation functions for symmTensor fields.
SourceFiles
symmTransformField.C

8
src/OpenFOAM/global/fileOperations/fileOperation/fileOperation.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -80,10 +80,10 @@ public:
static const NamedEnum<pathType, 12> pathTypeNames_;
//- Description of processor directory naming:
// - processor directory naming
// - whether directory contains a range
// + processor directory naming
// + whether directory contains a range
// (so differs on different processors)
// - index in range
// + index in range
typedef Tuple2<fileName, Tuple2<pathType, label>> dirIndex;
typedef List<dirIndex> dirIndexList;

6
src/OpenFOAM/meshes/meshShapes/face/faceListFwd.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,9 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::faceListFwd
Description
Foam::faceList
\*---------------------------------------------------------------------------*/

4
src/OpenFOAM/primitives/hashes/Hasher/HasherInt.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -56,7 +56,7 @@ namespace Foam
// \param[in] length - the number of values (not bytes)
// \param[in] hash1 - the previous hash, or an arbitrary value
// on output, the primary hash value
// \param[in] hash1 - the previous hash, or an arbitrary value
// \param[in] hash2 - the previous hash, or an arbitrary value
// on output, the secondary hash value
unsigned HasherDual
(

6
src/ThermophysicalTransportModels/coupledThermophysicalTransportModels/lumpedMassTemperature/lumpedMassTemperatureFvPatchScalarField.H
View File

@ -32,7 +32,7 @@ Description
the patch describes a closed volume (including in 2D meshes). Starting from
an initial, specified \c T, the change in temperature is calculated over
time according to an applied power source \c Q and the heat transferred
across the boundary \Q_{b} (positive into the lumped mass):
across the boundary \f$Q_{b}\f$ (positive into the lumped mass):
\f[
dT/dt = frac{Q + Q_{b}}{\rho C_{v} V}
@ -75,8 +75,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef BC_H
#define BC_H
#ifndef lumpedMassTemperatureFvPatchScalarField_H
#define lumpedMassTemperatureFvPatchScalarField_H
#include "fixedValueFvPatchFields.H"
#include "UniformDimensionedField.H"

10
src/ThermophysicalTransportModels/fluidMulticomponentThermo/fluidMulticomponentThermophysicalTransportModel.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::compressible::thermophysicalTransportModel
Foam::fluidMulticomponentThermophysicalTransportModel
Typedef
Foam::compressible::laminarThermophysicalTransportModel
Foam::laminarFluidMulticomponentThermophysicalTransportModel
Typedef
Foam::compressible::RASThermophysicalTransportModel
Foam::RASFluidMulticomponentThermophysicalTransportModel
Typedef
Foam::compressible::LESThermophysicalTransportModel
Foam::LESFluidMulticomponentThermophysicalTransportModel
Description
Typedefs for laminar, RAS and LES thermophysical transport models

10
src/ThermophysicalTransportModels/fluidThermo/fluidThermoThermophysicalTransportModel.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::compressible::fluidThermoThermophysicalTransportModel
Foam::fluidThermoThermophysicalTransportModel
Typedef
Foam::compressible::laminarThermophysicalTransportModel
Foam::laminarFluidThermophysicalTransportModel
Typedef
Foam::compressible::RASThermophysicalTransportModel
Foam::RASFluidThermophysicalTransportModel
Typedef
Foam::compressible::LESThermophysicalTransportModel
Foam::LESFluidThermophysicalTransportModel
Description
Typedefs for laminar, RAS and LES thermophysical transport models

10
src/ThermophysicalTransportModels/phaseFluidMulticomponentThermo/phaseFluidMulticomponentThermophysicalTransportModel.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::phaseCompressible::thermophysicalTransportModel
Foam::phaseFluidMulticomponentThermophysicalTransportModel
Typedef
Foam::phaseCompressible::laminarThermophysicalTransportModel
Foam::laminarPhaseFluidMulticomponentThermophysicalTransportModel
Typedef
Foam::phaseCompressible::RASThermophysicalTransportModel
Foam::RASPhaseFluidMulticomponentThermophysicalTransportModel
Typedef
Foam::phaseCompressible::LESThermophysicalTransportModel
Foam::LESPhaseFluidMulticomponentThermophysicalTransportModel
Description
Typedefs for laminar, RAS and LES thermophysical transport models

10
src/ThermophysicalTransportModels/phaseFluidThermo/phaseFluidThermophysicalTransportModel.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef
Foam::phaseCompressible::thermophysicalTransportModel
Foam::phaseFluidThermophysicalTransportModel
Typedef
Foam::phaseCompressible::laminarThermophysicalTransportModel
Foam::laminarPhaseFluidThermophysicalTransportModel
Typedef
Foam::phaseCompressible::RASThermophysicalTransportModel
Foam::RASPhaseFluidThermophysicalTransportModel
Typedef
Foam::phaseCompressible::LESThermophysicalTransportModel
Foam::LESPhaseFluidThermophysicalTransportModel
Description
Typedefs for laminar, RAS and LES thermophysical transport models

3
src/finiteVolume/cfdTools/general/MRF/derivedFvPatchFields/MRFnoSlip/MRFnoSlipFvPatchVectorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2022-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2022-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,6 +49,7 @@ Usage
type MRFnoSlip;
MRFZoneName rotor;
}
\endverbatim
See also
Foam::MRFPatchField

3
src/finiteVolume/cfdTools/general/MRF/derivedFvPatchFields/MRFslip/MRFslipFvPatchVectorField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2022-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2022-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,6 +49,7 @@ Usage
type MRFslip;
MRFZoneName rotor;
}
\endverbatim
See also
Foam::MRFPatchField

8
src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,11 +34,11 @@ Description
where
\vartable
p_rgh | Pressure - \rho g.(h - hRef) [Pa]
ph_rgh | Hydrostatic pressure - \rho g.(h - hRef) [Pa]
p_rgh | Pressure - rho g.(h - hRef) [Pa]
ph_rgh | Hydrostatic pressure - rho g.(h - hRef) [Pa]
h | Height in the opposite direction to gravity
hRef | Reference height in the opposite direction to gravity
\rho | Density
rho | Density
g | Acceleration due to gravity [m/s^2]
\endtable

2
src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
View File

@ -67,7 +67,7 @@ Usage
}
\endverbatim
The \c volumetricFlowRate or \c massFlowRate and the \omega entries are
The \c volumetricFlowRate or \c massFlowRate and the \c omega entries are
\c Function1 of time, see Foam::Function1s. The \c radialVelocity and
\c tangentialVelocity entries are \c Function2 of time and radius,
see Foam::Function2s.

4
src/fvMeshMovers/motionSolver/fvMeshMoversMotionSolver.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2021-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fvMeshMovers:motionSolver
Foam::fvMeshMovers::motionSolver
Description

3
src/fvMeshMovers/multiValveEngine/multiValveEngine.H
View File

@ -95,7 +95,7 @@ Description
Some of the above parameters are highlighted in a given schematic
piston-valve configuration w.r.t entries used to control piston motion.
Furthermore, an example dictionary entries are provided below.
\verbatim
| | | |
| | | |
| | S | |
@ -121,6 +121,7 @@ Description
| : || movingFrozenLayerThickness : |
|________:_________________________\/____________________________:________|
PISTON
\endverbatim
\verbatim
mover

8
src/mesh/snappyHexMesh/snappyHexMeshDriver/snappySnapDriver.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -598,9 +598,9 @@ public:
);
//- Repatch faces according to surface nearest the face centre
// - calculate face-wise snap distance as max of point-wise
// - calculate face-wise nearest surface point
// - repatch face according to patch for surface point.
// + calculate face-wise snap distance as max of point-wise
// + calculate face-wise nearest surface point
// + repatch face according to patch for surface point.
autoPtr<polyTopoChangeMap> repatchToSurface
(
const snapParameters& snapParams,

5
src/meshTools/coordinateSystems/coordinateSystem.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -49,8 +49,7 @@ Description
-# EulerCoordinateRotation
Type of co-ordinates:
-# \link cartesianCS cartesian \endlink
-# cartesianCS cartesian
SourceFiles
coordinateSystem.C

6
src/meshTools/triSurface/surfaceFeatures/surfaceFeatures.H
View File

@ -439,9 +439,9 @@ void selectCutEdges
);
//- Divide into multiple normal bins
// - return REGION if != 2 normals
// - return REGION if 2 normals that make feature angle
// - otherwise return NONE and set normals,bins
// + return REGION if != 2 normals
// + return REGION if 2 normals that make feature angle
// + otherwise return NONE and set normals,bins
surfaceFeatures::edgeStatus checkNonManifoldEdge
(
const triSurface& surf,

8
src/parallel/decompose/decompositionMethods/decompositionMethod/decompositionMethod.C
View File

@ -826,17 +826,9 @@ Foam::labelList Foam::decompositionMethod::decompose
(
const polyMesh& mesh,
const scalarField& cellWeights,
//- Whether owner and neighbour should be on same processor
// (takes priority over explicitConnections)
const boolList& blockedFace,
//- Whether whole sets of faces (and point neighbours) need to be kept
// on single processor
const PtrList<labelList>& specifiedProcessorFaces,
const labelList& specifiedProcessor,
//- Additional connections between boundary faces
const List<labelPair>& explicitConnections
)
{

21
src/parallel/decompose/decompositionMethods/decompositionMethod/decompositionMethod.H
View File

@ -300,16 +300,17 @@ public:
labelList& finalDecomp
);
// Decompose a mesh with constraints:
// - blockedFace : whether owner and neighbour should be on same
// processor
// - specifiedProcessorFaces, specifiedProcessor : sets of faces
// that should go to same processor (as specified in
// specifiedProcessor, can be -1)
// - explicitConnections : connections between baffle faces
// (blockedFace should be false on these). Owner and
// neighbour on same processor.
// Set all to zero size to have unconstrained decomposition.
//- Decompose a mesh with constraints
// Constraints:
// - blockedFace : whether owner and neighbour should be on same
// processor
// - specifiedProcessorFaces, specifiedProcessor : sets of faces
// that should go to same processor (as specified in
// specifiedProcessor, can be -1)
// - explicitConnections : connections between baffle faces
// (blockedFace should be false on these). Owner and
// neighbour on same processor.
// Set all to zero size to have unconstrained decomposition.
virtual labelList decompose
(
const polyMesh& mesh,

5
src/thermophysicalModels/specie/thermo/hPower/hPowerThermo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -22,6 +22,9 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::hPowerThermo
Description
Enthalpy based thermodynamics package using a power function of temperature
for the constant heat capacity at constant volume which is particularly
suitable for solids at low temperatures: