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

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

@ -92,7 +92,7 @@ Usage
otherwise to standard output otherwise to standard output
- \par -includes - \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 - \par -output
Path name of the output dictionary, defaults to the input dictionary 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. # The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES. # 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 # 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 # 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. # Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES. # 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 # 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 # 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2023-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -25,9 +25,9 @@ Class
Foam::functionEntries::calcIncludeEntry Foam::functionEntries::calcIncludeEntry
Description 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 \verbatim
angleOfAttack 5; // degs angleOfAttack 5; // degs
@ -92,7 +92,7 @@ public:
//- Execute the functionEntry in a sub-dict context //- Execute the functionEntry in a sub-dict context
static bool execute(dictionary& parentDict, Istream&); 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(); static void clear();
//- Add the cached include file names to the codeInclude entry //- 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2018-2022 OpenFOAM Foundation \\ / A nd | Copyright (C) 2018-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -56,7 +56,7 @@ Description
- the comparison is a string comparison for any word/string/variable, - the comparison is a string comparison for any word/string/variable,
integer comparison for two integers and floating point comparison for integer comparison for two integers and floating point comparison for
any floating point number. 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 See also
Foam::functionEntries::ifEntry 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 field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c -postProcess command-line option. 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 functionObjects are selected by entries in the $FOAM_CASE/system/functions
dictionary e.g. to select the \c functionObjectType functionObject the dictionary e.g. to select the \c functionObjectType functionObject the
following entry would be specified: 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 You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef InNamespace
Foam::typeInfo Foam
Description Description
Basic run-time type information using word as the type's name. 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -21,11 +21,11 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef InNamespace
Foam::symmTransformField Foam
Description Description
Spatial transformation functions for primitive fields. Spatial transformation functions for symmTensor fields.
SourceFiles SourceFiles
symmTransformField.C symmTransformField.C

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

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2017-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2017-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -80,10 +80,10 @@ public:
static const NamedEnum<pathType, 12> pathTypeNames_; static const NamedEnum<pathType, 12> pathTypeNames_;
//- Description of processor directory naming: //- Description of processor directory naming:
// - processor directory naming // + processor directory naming
// - whether directory contains a range // + whether directory contains a range
// (so differs on different processors) // (so differs on different processors)
// - index in range // + index in range
typedef Tuple2<fileName, Tuple2<pathType, label>> dirIndex; typedef Tuple2<fileName, Tuple2<pathType, label>> dirIndex;
typedef List<dirIndex> dirIndexList; 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,9 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef Typedef
Foam::faceListFwd Foam::faceList
Description
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

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

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -56,7 +56,7 @@ namespace Foam
// \param[in] length - the number of values (not bytes) // \param[in] length - the number of values (not bytes)
// \param[in] hash1 - the previous hash, or an arbitrary value // \param[in] hash1 - the previous hash, or an arbitrary value
// on output, the primary hash 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 // on output, the secondary hash value
unsigned HasherDual 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 the patch describes a closed volume (including in 2D meshes). Starting from
an initial, specified \c T, the change in temperature is calculated over 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 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[ \f[
dT/dt = frac{Q + Q_{b}}{\rho C_{v} V} dT/dt = frac{Q + Q_{b}}{\rho C_{v} V}
@ -75,8 +75,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef BC_H #ifndef lumpedMassTemperatureFvPatchScalarField_H
#define BC_H #define lumpedMassTemperatureFvPatchScalarField_H
#include "fixedValueFvPatchFields.H" #include "fixedValueFvPatchFields.H"
#include "UniformDimensionedField.H" #include "UniformDimensionedField.H"

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

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef Typedef
Foam::compressible::thermophysicalTransportModel Foam::fluidMulticomponentThermophysicalTransportModel
Typedef Typedef
Foam::compressible::laminarThermophysicalTransportModel Foam::laminarFluidMulticomponentThermophysicalTransportModel
Typedef Typedef
Foam::compressible::RASThermophysicalTransportModel Foam::RASFluidMulticomponentThermophysicalTransportModel
Typedef Typedef
Foam::compressible::LESThermophysicalTransportModel Foam::LESFluidMulticomponentThermophysicalTransportModel
Description Description
Typedefs for laminar, RAS and LES thermophysical transport models 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef Typedef
Foam::compressible::fluidThermoThermophysicalTransportModel Foam::fluidThermoThermophysicalTransportModel
Typedef Typedef
Foam::compressible::laminarThermophysicalTransportModel Foam::laminarFluidThermophysicalTransportModel
Typedef Typedef
Foam::compressible::RASThermophysicalTransportModel Foam::RASFluidThermophysicalTransportModel
Typedef Typedef
Foam::compressible::LESThermophysicalTransportModel Foam::LESFluidThermophysicalTransportModel
Description Description
Typedefs for laminar, RAS and LES thermophysical transport models 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef Typedef
Foam::phaseCompressible::thermophysicalTransportModel Foam::phaseFluidMulticomponentThermophysicalTransportModel
Typedef Typedef
Foam::phaseCompressible::laminarThermophysicalTransportModel Foam::laminarPhaseFluidMulticomponentThermophysicalTransportModel
Typedef Typedef
Foam::phaseCompressible::RASThermophysicalTransportModel Foam::RASPhaseFluidMulticomponentThermophysicalTransportModel
Typedef Typedef
Foam::phaseCompressible::LESThermophysicalTransportModel Foam::LESPhaseFluidMulticomponentThermophysicalTransportModel
Description Description
Typedefs for laminar, RAS and LES thermophysical transport models 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2020-2021 OpenFOAM Foundation \\ / A nd | Copyright (C) 2020-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,16 +22,16 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Typedef Typedef
Foam::phaseCompressible::thermophysicalTransportModel Foam::phaseFluidThermophysicalTransportModel
Typedef Typedef
Foam::phaseCompressible::laminarThermophysicalTransportModel Foam::laminarPhaseFluidThermophysicalTransportModel
Typedef Typedef
Foam::phaseCompressible::RASThermophysicalTransportModel Foam::RASPhaseFluidThermophysicalTransportModel
Typedef Typedef
Foam::phaseCompressible::LESThermophysicalTransportModel Foam::LESPhaseFluidThermophysicalTransportModel
Description Description
Typedefs for laminar, RAS and LES thermophysical transport models 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2022-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2022-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -49,6 +49,7 @@ Usage
type MRFnoSlip; type MRFnoSlip;
MRFZoneName rotor; MRFZoneName rotor;
} }
\endverbatim
See also See also
Foam::MRFPatchField 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2022-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2022-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -49,6 +49,7 @@ Usage
type MRFslip; type MRFslip;
MRFZoneName rotor; MRFZoneName rotor;
} }
\endverbatim
See also See also
Foam::MRFPatchField 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2016-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -34,11 +34,11 @@ Description
where where
\vartable \vartable
p_rgh | Pressure - \rho g.(h - hRef) [Pa] p_rgh | Pressure - rho g.(h - hRef) [Pa]
ph_rgh | Hydrostatic pressure - \rho g.(h - hRef) [Pa] ph_rgh | Hydrostatic pressure - rho g.(h - hRef) [Pa]
h | Height in the opposite direction to gravity h | Height in the opposite direction to gravity
hRef | Reference 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] g | Acceleration due to gravity [m/s^2]
\endtable \endtable

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

@ -67,7 +67,7 @@ Usage
} }
\endverbatim \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 Function1 of time, see Foam::Function1s. The \c radialVelocity and
\c tangentialVelocity entries are \c Function2 of time and radius, \c tangentialVelocity entries are \c Function2 of time and radius,
see Foam::Function2s. see Foam::Function2s.

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

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2021-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2021-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::fvMeshMovers:motionSolver Foam::fvMeshMovers::motionSolver
Description 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 Some of the above parameters are highlighted in a given schematic
piston-valve configuration w.r.t entries used to control piston motion. piston-valve configuration w.r.t entries used to control piston motion.
Furthermore, an example dictionary entries are provided below. Furthermore, an example dictionary entries are provided below.
\verbatim
| | | | | | | |
| | | | | | | |
| | S | | | | S | |
@ -121,6 +121,7 @@ Description
| : || movingFrozenLayerThickness : | | : || movingFrozenLayerThickness : |
|________:_________________________\/____________________________:________| |________:_________________________\/____________________________:________|
PISTON PISTON
\endverbatim
\verbatim \verbatim
mover mover

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

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

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

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

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

@ -439,9 +439,9 @@ void selectCutEdges
); );
//- Divide into multiple normal bins //- Divide into multiple normal bins
// - return REGION if != 2 normals // + return REGION if != 2 normals
// - return REGION if 2 normals that make feature angle // + return REGION if 2 normals that make feature angle
// - otherwise return NONE and set normals,bins // + otherwise return NONE and set normals,bins
surfaceFeatures::edgeStatus checkNonManifoldEdge surfaceFeatures::edgeStatus checkNonManifoldEdge
( (
const triSurface& surf, 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 polyMesh& mesh,
const scalarField& cellWeights, const scalarField& cellWeights,
//- Whether owner and neighbour should be on same processor
// (takes priority over explicitConnections)
const boolList& blockedFace, const boolList& blockedFace,
//- Whether whole sets of faces (and point neighbours) need to be kept
// on single processor
const PtrList<labelList>& specifiedProcessorFaces, const PtrList<labelList>& specifiedProcessorFaces,
const labelList& specifiedProcessor, const labelList& specifiedProcessor,
//- Additional connections between boundary faces
const List<labelPair>& explicitConnections const List<labelPair>& explicitConnections
) )
{ {

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

@ -300,16 +300,17 @@ public:
labelList& finalDecomp labelList& finalDecomp
); );
// Decompose a mesh with constraints: //- Decompose a mesh with constraints
// - blockedFace : whether owner and neighbour should be on same // Constraints:
// processor // - blockedFace : whether owner and neighbour should be on same
// - specifiedProcessorFaces, specifiedProcessor : sets of faces // processor
// that should go to same processor (as specified in // - specifiedProcessorFaces, specifiedProcessor : sets of faces
// specifiedProcessor, can be -1) // that should go to same processor (as specified in
// - explicitConnections : connections between baffle faces // specifiedProcessor, can be -1)
// (blockedFace should be false on these). Owner and // - explicitConnections : connections between baffle faces
// neighbour on same processor. // (blockedFace should be false on these). Owner and
// Set all to zero size to have unconstrained decomposition. // neighbour on same processor.
// Set all to zero size to have unconstrained decomposition.
virtual labelList decompose virtual labelList decompose
( (
const polyMesh& mesh, 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 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org \\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-2023 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2024 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,6 +22,9 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::hPowerThermo
Description
Enthalpy based thermodynamics package using a power function of temperature Enthalpy based thermodynamics package using a power function of temperature
for the constant heat capacity at constant volume which is particularly for the constant heat capacity at constant volume which is particularly
suitable for solids at low temperatures: suitable for solids at low temperatures: