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 
Typos in documentation strings corrected with the aid of codespell
This commit is contained in:
Henry Weller
2024-07-06 10:32:56 +01:00
parent 5405cb9375
commit 5babe5c67c
60 changed files with 122 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/OpenFOAM/containers/Lists/CompactListList/CompactListList.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
@ -94,7 +94,7 @@ public:
//- Construct from components
inline CompactListList(const UList<label>& offsets, const UList<T>& m);
//- Construct as copy or re-use as specified.
//- Construct as copy or reuse as specified.
inline CompactListList(CompactListList<T>&, bool reuse);
//- Move constructor

4
src/OpenFOAM/containers/Lists/List/List.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
@ -150,7 +150,7 @@ public:
//- Move constructor
List(List<T>&&);
//- Construct as copy or re-use as specified
//- Construct as copy or reuse as specified
List(List<T>&, bool reuse);
//- Construct as subset

4
src/OpenFOAM/containers/Lists/PtrList/PtrList.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
@ -104,7 +104,7 @@ public:
//- Move constructor
PtrList(PtrList<T>&&);
//- Construct as copy or re-use as specified
//- Construct as copy or reuse as specified
PtrList(PtrList<T>&, bool reuse);
//- Construct as copy of SLPtrList<T>

4
src/OpenFOAM/containers/Lists/UPtrList/UPtrList.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
@ -86,7 +86,7 @@ public:
//- Construct with size specified
explicit UPtrList(const label);
//- Construct as copy or re-use as specified
//- Construct as copy or reuse as specified
UPtrList(UPtrList<T>&, bool reuse);

4
src/OpenFOAM/db/IOobject/IOobject.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
@ -392,7 +392,7 @@ public:
const fileName& caseName(const bool global) const;
//- Return the instance directory, constant, system, <time> etc.
//- Return the instance directory, constant, system, \<time\> etc.
// Allows modification of the instance
fileName& instance() const;

4
src/OpenFOAM/db/IOobjects/IOdictionary/timeIOdictionary.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-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2021-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
timeIOdictionary derived from IOdictionary with globalFile set false to
enable writing to processor time directories.
Used for time-dependent global data written to the <time>/uniform
Used for time-dependent global data written to the \<time\>/uniform
directories.
SourceFiles

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

@ -171,7 +171,7 @@ inline bool isA(const Type& t)
//- Return the name of the object within the given type
// as <typeName>:<name>
// as \<typeName\>:\<name\>
template<class TypeName, class Name>
inline word typedName(Name name)
{

6
src/OpenFOAM/fields/DimensionedFields/DimensionedField/DimensionedField.H
View File

@ -176,7 +176,7 @@ public:
const DimensionedField<Type, GeoMesh>&
);
//- Copy constructor or re-use as specified.
//- Copy constructor or reuse as specified.
DimensionedField
(
DimensionedField<Type, GeoMesh>&,
@ -203,7 +203,7 @@ public:
const bool checkIOFlags = true
);
//- Copy constructor resetting IO parameters and re-use as specified.
//- Copy constructor resetting IO parameters and reuse as specified.
DimensionedField
(
const IOobject&,
@ -227,7 +227,7 @@ public:
const DimensionedField<Type, GeoMesh>&
);
//- Copy constructor resetting name and re-use as specified.
//- Copy constructor resetting name and reuse as specified.
DimensionedField
(
const word& newName,

4
src/OpenFOAM/fields/FieldFields/FieldField/FieldField.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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -104,7 +104,7 @@ public:
//- Move constructor
FieldField(FieldField<Field, Type>&&);
//- Construct as copy or re-use as specified.
//- Construct as copy or reuse as specified.
FieldField(FieldField<Field, Type>&, bool reuse);
//- Construct as copy of a PtrList<Field, Type>

2
src/OpenFOAM/fields/Fields/DynamicField/DynamicField.H
View File

@ -136,7 +136,7 @@ public:
//- Copy constructor
inline DynamicField(const DynamicField<T, SizeInc, SizeMult, SizeDiv>&);
//- Copy constructor or re-use as specified
//- Copy constructor or reuse as specified
inline DynamicField
(
DynamicField<T, SizeInc, SizeMult, SizeDiv>&,

2
src/OpenFOAM/fields/Fields/Field/Field.H
View File

@ -144,7 +144,7 @@ public:
//- Copy constructor
Field(const Field<Type>&);
//- Copy constructor or re-use as specified.
//- Copy constructor or reuse as specified.
Field(Field<Type>&, bool reuse);
//- Move constructor transferring the Field contents

12
src/OpenFOAM/global/fileOperations/collatedFileOperation/hostCollatedFileOperation.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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -27,11 +27,11 @@ Class
Description
Version of collatedFileOperation with multiple read/write ranks.
In parallel it will assume ranks are sorted according to hostname
and the lowest rank per hostname will be the IO rank. The output directories
will get a unique name processors<N>_<low>-<high> where N is the overall
number of processors and low and high is the range of ranks contained
in the files. Each of these subsets uses its own communicator.
In parallel it will assume ranks are sorted according to hostname and the
lowest rank per hostname will be the IO rank. The output directories will
get a unique name processors\<N\>_\<low\>-\<high\> where N is the overall
number of processors and low and high is the range of ranks contained in the
files. Each of these subsets uses its own communicator.
Instead of using the hostnames the IO ranks can be assigned using the
FOAM_IORANKS environment variable (also when running non-parallel), e.g.

6
src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.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-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2017-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -40,12 +40,12 @@ Description
- different path on all processors (processor0/0/p)
system/controlDict:
filePath worldmaster: <globalRoot>/system/controlDict
filePath worldmaster: \<globalRoot\>/system/controlDict
localmaster: ,,
slave : ,,
processor0/uniform/time
filePath worldmaster: <globalRoot>/processorXXX/uniform/time
filePath worldmaster: \<globalRoot\>/processorXXX/uniform/time
localmaster: ,,
slave : ,,

4
src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduMatrix.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
@ -472,7 +472,7 @@ public:
//- Copy constructor
LduMatrix(const LduMatrix<Type, DType, LUType>&);
//- Copy constructor or re-use as specified.
//- Copy constructor or reuse as specified.
LduMatrix(LduMatrix<Type, DType, LUType>&, bool reuse);
//- Construct given an LDU addressed mesh and an Istream

4
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -525,7 +525,7 @@ public:
//- Copy constructor
lduMatrix(const lduMatrix&);
//- Copy constructor or re-use as specified.
//- Copy constructor or reuse as specified.
lduMatrix(lduMatrix&, bool reuse);
//- Construct given an LDU addressed mesh and an Istream

4
src/OpenFOAM/meshes/lduMesh/lduPrimitiveMesh.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
@ -122,7 +122,7 @@ public:
const lduSchedule& ps
);
//- Construct from components and re-use storage.
//- Construct from components and reuse storage.
lduPrimitiveMesh
(
const label nCells,

4
src/OpenFOAM/meshes/meshShapes/cell/cell.C
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
@ -57,7 +57,7 @@ Foam::labelList Foam::cell::labels(const faceUList& f) const
p[pointi] = first[pointi];
}
// re-use maxVert to count the real vertices
// reuse maxVert to count the real vertices
maxVert = first.size();
// go through the rest of the faces. For each vertex, check if the point is

2
src/OpenFOAM/meshes/pointMesh/pointMeshMapper/pointMapper.C
View File

@ -237,7 +237,7 @@ const Foam::labelUList& Foam::pointMapper::directAddressing() const
if (!insertedObjects())
{
// No inserted points. Re-use pointMap
// No inserted points. Reuse pointMap
return map_.pointMap();
}
else

2
src/OpenFOAM/meshes/polyMesh/polyTopoChangeMap/cellMapper/cellMapper.C
View File

@ -287,7 +287,7 @@ const Foam::labelUList& Foam::cellMapper::directAddressing() const
if (!insertedObjects())
{
// No inserted cells. Re-use cellMap
// No inserted cells. Reuse cellMap
return mpm_.cellMap();
}
else

2
src/OpenFOAM/meshes/polyMesh/polyTopoChangeMap/faceMapper/faceMapper.C
View File

@ -226,7 +226,7 @@ const Foam::labelUList& Foam::faceMapper::directAddressing() const
if (!insertedObjects())
{
// No inserted faces. Re-use faceMap
// No inserted faces. Reuse faceMap
return mpm_.faceMap();
}
else

2
src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.H
View File

@ -355,7 +355,7 @@ public:
// 0 : none of the above.
label distanceCmp(const point&, const treeBoundBox& other) const;
//- Return asymetrically extended bounding box, with guaranteed
//- Return asymmetrically extended bounding box, with guaranteed
// minimum width of s*mag(span) in any direction
inline treeBoundBox extend(const scalar s) const;

2
src/OpenFOAM/primitives/functions/Function2/Product/Product2.H
View File

@ -49,7 +49,7 @@ Description
}
\endverbatim
Note that only one type specification (the <vector>/<scalar>/... part)
Note that only one type specification (the \<vector\>/\<scalar\>/... part)
is needed in general for the value entries, and no type specifications
are needed if the function is scalar.

4
src/ThermophysicalTransportModels/fluid/laminar/MaxwellStefan/MaxwellStefan.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::turbulenceThermophysicalTransportModels::MaxwellStefan
Foam::MaxwellStefan
Description
Base class for multi-component Maxwell Stefan generalised Fick's law

2
src/finiteVolume/fvMesh/fvMeshStitchers/fvMeshStitcher/fvMeshStitcher.H
View File

@ -82,7 +82,7 @@ private:
//- Flag to indicate whether this region is ready to be stitched
bool ready_;
//- Cache of leaded region poly face IO objects
//- Cache of loaded region poly face IO objects
HashPtrTable<IOobject> regionPolyFacesBfIOs_;
//- Cache of loaded region poly face boundary fields

4
src/functionObjects/field/comfort/comfort.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2019-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2019-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -63,7 +63,7 @@ Foam::dimensionedScalar Foam::functionObjects::comfort::Trad() const
// The mean radiation is calculated by the mean wall temperatures
// which are summed and divided by the area | only walls are taken into
// account. This approach might be correct for a squared room but will
// defintely be inconsistent for complex room geometries. The norm does
// definitely be inconsistent for complex room geometries. The norm does
// not provide any information about the calculation of this quantity.
if (!TradSet_)
{

2
src/functionObjects/field/wallShearStress/wallShearStress.H
View File

@ -26,7 +26,7 @@ Class
Description
Calculates and write the shear-stress at wall patches as
the volVectorField field 'wallShearStress' or 'wallShearStress.<phase>'.
the volVectorField field 'wallShearStress' or 'wallShearStress.\<phase\>'.
\f[
Stress = R \dot n

4
src/functionObjects/field/yPlus/yPlus.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) 2013-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -26,7 +26,7 @@ Class
Description
Evaluates and outputs turbulence y+ for models. Values written to
time directories as field 'yPlus' or 'yPlus.<phase>'.
time directories as field 'yPlus' or 'yPlus.\<phase\>'.
Example of function object specification:
\verbatim

2
src/functionObjects/forces/forces/forces.H
View File

@ -78,7 +78,7 @@ Usage
- For incompressible cases, set \c rho to \c rhoInf and provide
a \c rhoInf value corresponding to the free-stream constant density.
- If the \c phase name is specified the corresponding phase-fraction field
\c alpha.<phase> is used to filter the surface force field
\c alpha.\<phase\> is used to filter the surface force field
before integration.
- If the force density is supplied directly, set the \c directForceDensity
flag to 'yes', and supply the force density field using the \c

2
src/functionObjects/forces/movingForces/movingForces.H
View File

@ -84,7 +84,7 @@ Usage
- For incompressible cases, set \c rho to \c rhoInf and provide
a \c rhoInf value corresponding to the free-stream constant density.
- If the \c phase name is specified the corresponding phase-fraction field
\c alpha.<phase> is used to filter the surface force field
\c alpha.\<phase\> is used to filter the surface force field
before integration.
- If the force density is supplied directly, set the \c directForceDensity
flag to 'yes', and supply the force density field using the \c

8
src/functionObjects/utilities/stopAt/stopAtFile/stopAtFile.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
@ -28,8 +28,8 @@ Description
Stops the run when the specified file is created in the case directory
and optionally write results before stopping.
The default name of the trigger file is \c $FOAM_CASE/<name> where \c
<name> is the name of the functionObject entry.
The default name of the trigger file is \c $FOAM_CASE/\<name\> where \c
\<name\> is the name of the functionObject entry.
Currently the following action types are supported:
- noWriteNow
@ -64,7 +64,7 @@ Usage
\table
Property | Description | Required | Default value
type | type name: stopAtFile | yes |
file | Trigger file path name | no | $FOAM_CASE/<name>
file | Trigger file path name | no | $FOAM_CASE/\<name\>
action | Action executed | no | nextWrite
\endtable

2
src/fvModels/general/buoyancyEnergy/buoyancyEnergy.H
View File

@ -70,7 +70,7 @@ class buoyancyEnergy
//- Optional phase name
word phaseName_;
//- Name of velocity field; default = U.<phase>
//- Name of velocity field; default = U.\<phase\>
word UName_;

4
src/fvModels/general/solidThermalEquilibrium/solidThermalEquilibrium.H
View File

@ -30,8 +30,8 @@ Description
surrounding fluid phase.
The volume fraction of the solid phase is read from
constant/alpha.<solidPhase>, and the associated thermophysical properties
are specified in constant/thermophysicalProperties.<solidPhase>.
constant/alpha.\<solidPhase\>, and the associated thermophysical properties
are specified in constant/thermophysicalProperties.\<solidPhase\>.
Usage
\table

8
src/fvModels/general/volumeBlockage/volumeBlockage.H
View File

@ -27,10 +27,10 @@ Class
Description
This fvModel adds transport terms into the equations to account for the
presence of a constant volume fraction. The volume fraction is read from
constant/alpha.<volumePhase>, where <volumePhase> is given as a parameter
to the fvModel. Both advective and diffusive terms are added, and the
resulting solution is time-accurate. The flux and velocity are treated as
superficial.
constant/alpha.\<volumePhase\>, where \<volumePhase\> is given as a
parameter to the fvModel. Both advective and diffusive terms are added, and
the resulting solution is time-accurate. The flux and velocity are treated
as superficial.
This can be used to represent the effect of porous media that are caused
purely by the reduction in volume of the fluid phase; i.e., additional

4
src/lagrangian/functionObjects/particles/particles.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
@ -36,7 +36,7 @@ Description
constant/phaseProperties dictionary and the acceleration due to gravity
which is read from the constant/g file if present or defaults to zero.
The cloud properties are read from the constant/<cloudName>Properties
The cloud properties are read from the constant/\<cloudName\>Properties
dictionary in the usual manner.
Example of function object specification:

4
src/lagrangian/parcel/fvModels/clouds/clouds.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
@ -33,7 +33,7 @@ Description
cloud. For a single cloud, these should be provided in the
constant/cloudProperties file. For multiple clouds, the list of cloud names
must first be provided in the constant/clouds file. Then, each named cloud
has its properties specified in its constant/<cloudName>Properties file.
has its properties specified in its constant/\<cloudName\>Properties file.
The application of sources to the Eulerian fields is controlled by the
solution/coupled switch in each cloud's properties file. If set to "true"

4
src/lagrangian/parcel/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.C
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
@ -156,7 +156,7 @@ void Foam::ReactingMultiphaseParcel<ParcelType>::cellValueSourceCorrection
const scalar dt
)
{
// Re-use correction from reacting parcel
// Reuse correction from reacting parcel
ParcelType::cellValueSourceCorrection(cloud, td, dt);
}

4
src/meshTools/cellsToCells/matching/matchingCellsToCells.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -198,7 +198,7 @@ void Foam::cellsToCellss::matching::appendToDirectSeeds
{
// source cell srcI not yet mapped
// identfy if target cell exists for source cell srcI
// identify if target cell exists for source cell srcI
bool found = false;
forAll(tgtNbr, j)
{

6
src/meshTools/edgeMesh/edgeMeshFormats/edgeMesh/edgeMeshFormat.C
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
@ -62,7 +62,7 @@ bool Foam::fileFormats::edgeMeshFormat::read
false // enableFunctionObjects
);
// Construct IOobject to re-use the headerOk & readHeader
// Construct IOobject to reuse the headerOk & readHeader
// (so we can read ascii and binary)
typeIOobject<featureEdgeMesh> io
(
@ -167,7 +167,7 @@ void Foam::fileFormats::edgeMeshFormat::write
false // enableFunctionObjects
);
// Construct IOobject to re-use the writeHeader
// Construct IOobject to reuse the writeHeader
IOobject io
(
filename,

4
src/meshTools/edgeMesh/extendedEdgeMesh/extendedEdgeMeshFormats/extendedEdgeMeshFormat/extendedEdgeMeshFormat.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -60,7 +60,7 @@ bool Foam::fileFormats::extendedEdgeMeshFormat::read
false // enableFunctionObjects
);
// Construct IOobject to re-use the headerOk & readHeader
// Construct IOobject to reuse the headerOk & readHeader
// (so we can read ascii and binary)
typeIOobject<extendedFeatureEdgeMesh> io
(

2
src/meshTools/sets/cellSources/truncatedConeToCell/truncatedConeToCell.H
View File

@ -58,7 +58,7 @@ class truncatedConeToCell
//- Second point on cylinder axis
vector point2_;
//- Radis 1
//- Radius 1
scalar radius1_;
//- Radius 2

4
src/radiationModels/radiationModels/viewFactor/viewFactor.C
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
@ -558,7 +558,7 @@ void Foam::radiationModels::viewFactor::calculate()
}
else // Constant emissivity
{
// Initial iter calculates CLU and chaches it
// Initial iter calculates CLU and caches it
if (iterCounter_ == 0)
{
for (label i=0; i<totalNCoarseFaces_; i++)

4
src/randomProcesses/fft/fftRenumber.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
@ -48,7 +48,7 @@ namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Recursively evaluate the indexing necessary to do the folding of the fft
// data. We recurse until we have the indexing ncessary for the folding in all
// data. We recurse until we have the indexing necessary for the folding in all
// directions.
void fftRenumberRecurse
(

2
src/rigidBodyMotion/rigidBodyForces/rigidBodyForces.H
View File

@ -77,7 +77,7 @@ Usage
- For incompressible cases, set \c rho to \c rhoInf and provide
a \c rhoInf value corresponding to the free-stream constant density.
- If the \c phase name is specified the corresponding phase-fraction field
\c alpha.<phase> is used to filter the surface force field
\c alpha.\<phase\> is used to filter the surface force field
before integration.
- If the force density is supplied directly, set the \c directForceDensity
flag to 'yes', and supply the force density field using the \c

4
src/surfMesh/UnsortedMeshedSurface/UnsortedMeshedSurface.C
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
@ -477,7 +477,7 @@ Foam::surfZoneList Foam::UnsortedMeshedSurface<Face>::sortedZones
}
// step 2: assign start/size (and name) to the newZones
// re-use the lookup to map (zoneId => zoneI)
// reuse the lookup to map (zoneId => zoneI)
surfZoneList zoneLst(lookup.size());
label start = 0;
label zoneI = 0;

12
src/waves/fvModels/waveForcing/waveForcing.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
@ -36,14 +36,14 @@ Description
to force for 5 time-scales, then \f$\lambda\f$ should be set to equal 5/(4
[s]) = 1.2 [1/s]. If more aggressive forcing is required adjacent to the
boundaries, which is often the case if wave boundary conditions are
specified at outflow boundaries, the optional \f$\lambdaBoundary\f$
specified at outflow boundaries, the optional \c lambdaBoundary
coefficient can be specified higher than the value of \f$\lambda\f$.
Alternatively the forcing force coefficient \f$\lambdaCoeff\f$ can be
Alternatively the forcing force coefficient \c lambdaCoeff can be
specified in which case \f$\lambda\f$ is evaluated by multiplying the
maximum wave speed by \f$\lambdaCoeff\f$ and dividing by the forcing region
length. \f$\lambdaBoundary\f$ is similarly evaluated from
\f$\lambdaBoundaryCoeff\f$ if specified.
maximum wave speed by \c lambdaCoeff and dividing by the forcing region
length. \c lambdaBoundary is similarly evaluated from
\c lambdaBoundaryCoeff if specified.
Usage
Example usage: