Code documentation: corrected typos

This commit is contained in:
Henry Weller
2022-05-20 10:42:25 +01:00
parent eb95e3f2c2
commit f54376b20c
43 changed files with 75 additions and 75 deletions

View File

@ -43,7 +43,7 @@ Description
but with an improved formulation for the coefficient \c A appropriate for
unstructured meshes including those with split-cell refinement patterns.
However the dimensioned length-scale coefficient \c delta remains and must
be set appropriatly for the case by performing test runs and comparing with
be set appropriately for the case by performing test runs and comparing with
known results. Clearly this model is far from general and more research is
needed in order that \c delta can be obtained directly from the interface
flow and turbulence conditions.

View File

@ -43,7 +43,7 @@ Description
but with an improved formulation for the coefficient \c A appropriate for
unstructured meshes including those with split-cell refinement patterns.
However the dimensioned length-scale coefficient \c delta remains and must
be set appropriatly for the case by performing test runs and comparing with
be set appropriately for the case by performing test runs and comparing with
known results. Clearly this model is far from general and more research is
needed in order that \c delta can be obtained directly from the interface
flow and turbulence conditions.

View File

@ -43,7 +43,7 @@ Description
but with an improved formulation for the coefficient \c A appropriate for
unstructured meshes including those with split-cell refinement patterns.
However the dimensioned length-scale coefficient \c delta remains and must
be set appropriatly for the case by performing test runs and comparing with
be set appropriately for the case by performing test runs and comparing with
known results. Clearly this model is far from general and more research is
needed in order that \c delta can be obtained directly from the interface
flow and turbulence conditions.

View File

@ -42,7 +42,7 @@ Description
alphaInversion can be set to a small value e.g. 1e-2, but unless the phase
turbulence model is specifically designed to handle phase-inversion and both
continuous and dispersed regimes it may be useful to set \c alphaInversion
to a higher value, corresponding to the phase-fraction at which transision
to a higher value, corresponding to the phase-fraction at which transition
from continuous to dispersed happens and effectively use the turbulence
properties of the other phase when the phase is dispersed. This is of
course an approximation to the real system and if accurate handling of both

View File

@ -28,7 +28,7 @@ Alternatively, you can "fuse" the different fluid regions in ccm+. To do
this select all the fluid regions you want to merge together from the
command tree on the left of your screen, under Regions. Press control
and click on top of each one, once you've selected all, click the
right-hand buttom of your mouse and select Fuse...
right-hand button of your mouse and select Fuse...
4. how to save it from star-ccm+

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -187,7 +187,7 @@ class sammMesh
void createBoundaryFaces();
//- Specialist version of face comparison to deal with
// PROSTAR boundary format idiosyncracies
// PROSTAR boundary format idiosyncrasies
bool sammEqualFace
(
const face& boundaryFace,

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -237,7 +237,7 @@ class starMesh
void collectBoundaryFaces();
//- Specialist version of face comparison to deal with
// PROSTAR boundary format idiosyncracies
// PROSTAR boundary format idiosyncrasies
bool starEqualFace
(
const face& boundaryFace,

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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,7 +33,7 @@ Description
// Min cell size used in tolerances when inserting points for
// boundary conforming.
// Also used to as the grid spacing usind in insertGrid.
// Also used as the grid spacing in insertGrid.
minCellSize 0.05;
// Feature angle used to inser feature points

View File

@ -65,7 +65,7 @@ extern "C" {
#define Z_STATIC (0) /* static geometry */
#define Z_CHANGE_COORDS (1) /* coordinate changing only */
#define Z_CHANGE_CONN (2) /* conectivity changing */
#define Z_CHANGE_CONN (2) /* connectivity changing */
#define Z_GEOM (0) /* Geometry type */
#define Z_VARI (1) /* Variable type */

View File

@ -77,7 +77,7 @@ void List<Type>::Add(Type t){
}
// int i;
// for(i=0;i<num;i++) {
// dissallow duplicates
// disallow duplicates
// assert(element[i] != t);
//}
element[num++] = t;

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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -25,7 +25,7 @@ Class
Foam::Dictionary
Description
Gerneral purpose template dictionary class which manages the storage
General purpose template dictionary class which manages the storage
associated with it.
It is derived from DictionaryBase instantiated on a memory managed form

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -71,7 +71,7 @@ class dictionaryEntry
void readData(Istream&);
//- Dissallow bitwise copy
//- Disallow bitwise copy
dictionaryEntry(const dictionary&);

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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2016-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -69,7 +69,7 @@ class dictionaryListEntry
//- Returns size of dictionary without FoamFile
static label realSize(const dictionary&);
//- Dissallow bitwise copy
//- Disallow bitwise copy
dictionaryListEntry(const dictionary&);

View File

@ -77,7 +77,7 @@ class regIOobject
//- Return Istream
Istream& readStream(const bool read = true);
//- Dissallow assignment
//- Disallow assignment
void operator=(const regIOobject&);

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -71,7 +71,7 @@ class procLduInterface
// Private Member Functions
//- Dissallow construction as copy
//- Disallow construction as copy
procLduInterface(const procLduInterface&);

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -73,7 +73,7 @@ class procLduMatrix
// Private Member Functions
//- Dissallow construction as copy
//- Disallow construction as copy
procLduMatrix(const procLduMatrix&);

View File

@ -418,7 +418,7 @@ public:
) const;
// Procesor agglomeration. Note that the mesh and agglomeration is
// Processor agglomeration. Note that the mesh and agglomeration is
// stored per fineLevel (even though it is the coarse level mesh that
// has been agglomerated). This is just for convenience and consistency
// with GAMGSolver notation.

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -56,10 +56,10 @@ class refCount
// Private Member Functions
//- Dissallow copy
//- Disallow copy
refCount(const refCount&);
//- Dissallow bitwise assignment
//- Disallow bitwise assignment
void operator=(const refCount&);

View File

@ -399,7 +399,7 @@ public:
fileName meshDir() const;
//- Return the current instance directory for points
// Used in the consruction of gemometric mesh data dependent
// Used in the construction of gemometric mesh data dependent
// on points
const fileName& pointsInstance() const;

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -279,7 +279,7 @@ void Foam::coupledPolyPatch::initOrder
// Generate the face tolerances
//
// !!! It is possble that a different metric would be more appropriate
// !!! It is possible that a different metric would be more appropriate
// for this method than the tolerance that was developed when all faces
// were being geometrically compared
//

View File

@ -93,7 +93,7 @@ class cyclicPolyPatch
mutable edgeList* coupledPointsPtr_;
//- List of connected edges. e[0] is the edge on this patch,
// e[1] the corresponding edge on the cyclic neigbour
// e[1] the corresponding edge on the cyclic neighbour
mutable edgeList* coupledEdgesPtr_;
//- Data to pass from owner.initOrder to nbr.order

View File

@ -25,7 +25,7 @@ Class
Foam::cyclicTransform
Description
Cyclic plane tranformation.
Cyclic plane transformation.
SourceFiles
cyclicTransform.C
@ -55,7 +55,7 @@ public:
enum transformTypes
{
UNSPECIFIED, // Unspecified -> automatic transformation
NONE, // No tranformation
NONE, // No transformation
ROTATIONAL, // Rotation around a coordinate axis
TRANSLATIONAL // Translation
};

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -128,9 +128,9 @@ Foam::string& Foam::stringOps::inplaceExpand
(
isalnum(*iter)
|| *iter == '/' // For dictionary slash syntax
|| *iter == '!' // For dictionary slash systax
|| *iter == '.' // For dictionary dot systax
|| *iter == ':' // For dictionary dot systax
|| *iter == '!' // For dictionary slash syntax
|| *iter == '.' // For dictionary dot syntax
|| *iter == ':' // For dictionary dot syntax
|| *iter == '_'
)
)
@ -408,9 +408,9 @@ Foam::string& Foam::stringOps::inplaceExpand
(
isalnum(*iter)
|| *iter == '/' // For dictionary slash syntax
|| *iter == '!' // For dictionary slash systax
|| *iter == '.' // For dictionary dot systax
|| *iter == ':' // For dictionary dot systax
|| *iter == '!' // For dictionary slash syntax
|| *iter == '.' // For dictionary dot syntax
|| *iter == ':' // For dictionary dot syntax
|| *iter == '_'
)
)
@ -547,9 +547,9 @@ Foam::string& Foam::stringOps::inplaceExpand
(
isalnum(*iter)
|| *iter == '/' // For dictionary slash syntax
|| *iter == '!' // For dictionary slash systax
|| *iter == '.' // For dictionary dot systax
|| *iter == ':' // For dictionary dot systax
|| *iter == '!' // For dictionary slash syntax
|| *iter == '.' // For dictionary dot syntax
|| *iter == ':' // For dictionary dot syntax
|| *iter == '_'
)
)

View File

@ -1794,7 +1794,7 @@ bool Foam::hexRef8::matchHexShape
const face& f = mesh_.faces()[facei];
// Pick up any faces with only one level point.
// See if there are four of these where the commont point
// See if there are four of these where the common point
// is a level+1 point. This common point is then the mid of
// a split face.

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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -81,7 +81,7 @@ bool Foam::slidingInterface::projectPoints() const
// edges of the face it has hit. If the distance is smaller than the
// edge merge tolerance, the point will be moved onto the edge.
// Remember the master edge index.
// 6) The remaning slave points will be projected into faces. Remember the
// 6) The remaining slave points will be projected into faces. Remember the
// master face index.
// 7) For the points that miss the master patch, grab the nearest face
// on the master and leave the slave point where it started

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-2020 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -227,7 +227,7 @@ private:
void read(ISstream& inFile);
//- Dissallow assignment
//- Disallow assignment
void operator=(const vtkUnstructuredReader&);

View File

@ -207,7 +207,7 @@ public:
//- Apply a constraint to an equation
FOR_ALL_FIELD_TYPES(DEFINE_FV_CONSTRAINT_CONSTRAIN);
//- Apply contraint to a field
//- Apply constraint to a field
FOR_ALL_FIELD_TYPES(DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD);

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,7 +28,7 @@ Description
This boundary condition provides an 'empty' condition for reduced
dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to
patches whose normal is aligned to geometric directions that do not
constitue solution directions.
constitute solution directions.
Usage
Example of the boundary condition specification:

View File

@ -153,7 +153,7 @@ namespace fvm
);
// Explict and implicit sources provided as a pair
// Explicit and implicit sources provided as a pair
template<class Type>
tmp<fvMatrix<Type>> S

View File

@ -129,7 +129,7 @@ Foam::SolverPerformance<Type> Foam::fvMatrix<Type>::solveSegregated
Field<Type> source(source_);
// At this point include the boundary source from the coupled boundaries.
// This is corrected for the implict part by updateMatrixInterfaces within
// This is corrected for the implicit part by updateMatrixInterfaces within
// the component loop.
addBoundarySource(source);

View File

@ -25,7 +25,7 @@ Class
Foam::extendedCellToFaceStencil
Description
Calculates/constains the extended cell-to-face stencil.
Calculates/contains the extended cell-to-face stencil.
The stencil is a list of indices into either cells or boundary faces
in a compact way. (element 0 is owner, 1 is neighbour). The index numbering

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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -26,7 +26,7 @@ Class
Description
fvMesh as subset of other mesh. Consists of one cell and all original
bounday faces. Useful when manipulating boundary data. Single internal
boundary faces. Useful when manipulating boundary data. Single internal
cell only needed to be able to manipulate in a standard way.
SourceFiles

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -39,7 +39,7 @@ Description
@verbatim
D.P. Schmidt, I. Nouar, P.K. Senecal, C.J. Rutland, J.K. Martin, R.D. Reitz
"Pressure-Swirl Atomisation in the Near Field"
SAE Techical Paper Series 1999-01-0496
SAE Technical Paper Series 1999-01-0496
@endverbatim
\*---------------------------------------------------------------------------*/

View File

@ -2045,7 +2045,7 @@ bool Foam::medialAxisMeshMover::shrinkMesh
// Make sure displacement boundary conditions is uptodate with
// Make sure displacement boundary conditions is up-to-date with
// internal field
meshMover_.setDisplacementPatchFields();

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -1710,7 +1710,7 @@ void Foam::snappyLayerDriver::shrinkMeshMedialDistance
}
}
// Make sure displacement boundary conditions is uptodate with
// Make sure displacement boundary conditions is up-to-date with
// internal field
meshMover.setDisplacementPatchFields();

View File

@ -276,7 +276,7 @@ Foam::label Foam::zoltanDecomp::decompose
Zoltan_Set_Param(zz, "obj_weight_dim", name(nWeights).c_str());
Zoltan_Set_Param(zz, "edge_weight_dim", "0");
// General default paramaters
// General default parameters
Zoltan_Set_Param(zz, "debug_level", "0");
Zoltan_Set_Param(zz, "imbalance_tol", "1.05");

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -47,7 +47,7 @@ Usage
{
type compressible::thermalBaffle;
// Underlaying coupled boundary condition
// Underlying coupled boundary condition
Tnbr T;
qrNbr qr;//or none.Name of qr field on neighbourregion
qr none;// or none.Name of qr field on localregion

View File

@ -92,7 +92,7 @@ protected:
const fvMesh& mesh_;
// Read from dictonary
// Read from dictionary
//- Names of fields to probe
wordList fields_;

View File

@ -87,7 +87,7 @@ class sampledSets
meshSearch searchEngine_;
// Read from dictonary
// Read from dictionary
//- Names of fields to sample
wordList fields_;

View File

@ -140,7 +140,7 @@ class sampledSurfaces
fileName outputPath_;
// Read from dictonary
// Read from dictionary
//- Names of fields to sample
wordList fields_;

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-2019 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -176,7 +176,7 @@ public:
fileName meshDir() const;
//- Return the current instance directory for points
// Used in the consruction of geometric mesh data dependent
// Used in the construction of geometric mesh data dependent
// on points
const fileName& pointsInstance() const;

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-2022 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -665,7 +665,7 @@ bool Foam::MPLICcell::singleCutCell
cellInfo.isOwner()[facei]
);
// Potentialy multiple cuts through the cell
// Potentially multiple cuts through the cell
if (cutType == -1)
{
moreCutsPerFace = 1;
@ -705,7 +705,7 @@ bool Foam::MPLICcell::singleCutCell
appendSfCf(cutSf_, Cf, mag(cutSf_));
}
// Potentialy multiple cuts through cell
// Potentially multiple cuts through cell
if (cutOrientationDiffers || moreCutsPerFace)
{
return 0;

View File

@ -7,8 +7,8 @@ usage () {
Usage: ${0##*/} [OPTIONS]
Options:
-i | -interface no refinment in vertical direction of the mesh
-l | -local mesh with local refinment
-i | -interface no refinement in vertical direction of the mesh
-l | -local mesh with local refinement
-h | -help help
Ship hull simulation to demonstrate two different meshing strategies that can be