research/OpenFOAM-5.x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Corrected "fileName" -> "file" in header documentation

Browse source 
Patch contributed by Bruno Santos
Resolves bug-report https://bugs.openfoam.org/view.php?id=2951
This commit is contained in:
Henry Weller 2018-05-22 22:32:59 +01:00
parent bfe333ff64
commit a522b1ffdb
11 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
applications/utilities/postProcessing/noise/noise.C
View file

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -43,7 +43,7 @@ Usage
pressureData pressureData
{ {
fileName "pressureData" file "pressureData";
nHeaderLine 1; // number of header lines nHeaderLine 1; // number of header lines
refColumn 0; // reference column index refColumn 0; // reference column index
componentColumns (1); // component column indices componentColumns (1); // component column indices

4
src/OpenFOAM/interpolations/interpolationTable/interpolationTable.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -42,7 +42,7 @@ Description
Read csv format: Read csv format:
\verbatim \verbatim
readerType csv; readerType csv;
fileName "$FOAM_CASE/constant/p0vsTime.csv"; file "$FOAM_CASE/constant/p0vsTime.csv";
hasHeaderLine true; // skip first line hasHeaderLine true; // skip first line
timeColumn 0; // time is in column 0 timeColumn 0; // time is in column 0
valueColumns (1); // value starts in column 1 valueColumns (1); // value starts in column 1

4
src/OpenFOAM/primitives/functions/Function1/CSV/CSV.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -39,7 +39,7 @@ Description
componentColumns (1 2 3); // component column indices componentColumns (1 2 3); // component column indices
separator ","; // optional (defaults to ",") separator ","; // optional (defaults to ",")
mergeSeparators no; // merge multiple separators mergeSeparators no; // merge multiple separators
fileName "fileXYZ"; // name of csv data file file "fileXYZ"; // name of csv data file
outOfBounds clamp; // optional out-of-bounds handling outOfBounds clamp; // optional out-of-bounds handling
interpolationScheme linear; // optional interpolation scheme interpolationScheme linear; // optional interpolation scheme
} }

4
src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -32,7 +32,7 @@ Description
<entryName> tableFile; <entryName> tableFile;
<entryName>Coeffs <entryName>Coeffs
{ {
fileName dataFile; // name of data file file dataFile; // name of data file
outOfBounds clamp; // optional out-of-bounds handling outOfBounds clamp; // optional out-of-bounds handling
interpolationScheme linear; // optional interpolation method interpolationScheme linear; // optional interpolation method
} }

6
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2013-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -87,7 +87,7 @@ Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
commsDir | communications directory | yes | commsDir | communications directory | yes |
fileName | transfer file name | yes | file | transfer file name | yes |
waitInterval | interval [s] between file checks | no | 1 waitInterval | interval [s] between file checks | no | 1
timeOut | time after which error invoked [s] |no |100*waitInterval timeOut | time after which error invoked [s] |no |100*waitInterval
calcFrequency | calculation frequency | no | 1 calcFrequency | calculation frequency | no | 1
@ -100,7 +100,7 @@ Usage
{ {
type externalCoupledTemperature; type externalCoupledTemperature;
commsDir "$FOAM_CASE/comms"; commsDir "$FOAM_CASE/comms";
fileName data; file data;
calcFrequency 1; calcFrequency 1;
} }
\endverbatim \endverbatim

6
src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2013-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -87,7 +87,7 @@ Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
commsDir | communications directory | yes | commsDir | communications directory | yes |
fileName | transfer file name | yes | file | transfer file name | yes |
waitInterval | interval [s] between file checks | no | 1 waitInterval | interval [s] between file checks | no | 1
timeOut | time after which error invoked [s] |no |100*waitInterval timeOut | time after which error invoked [s] |no |100*waitInterval
calcFrequency | calculation frequency | no | 1 calcFrequency | calculation frequency | no | 1
@ -101,7 +101,7 @@ Usage
{ {
type externalCoupled; type externalCoupled;
commsDir "$FOAM_CASE/comms"; commsDir "$FOAM_CASE/comms";
fileName data; file data;
calcFrequency 1; calcFrequency 1;
initByExternal yes; initByExternal yes;
} }

4
src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -56,7 +56,7 @@ Usage
refColumn 0; refColumn 0;
componentColumns 1(1); componentColumns 1(1);
separator ","; separator ",";
fileName "$FOAM_CASE/constant/pressureVsU"; file "$FOAM_CASE/constant/pressureVsU";
} }
value uniform 0; value uniform 0;
} }

8
src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -34,7 +34,7 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fileName | fan curve file name | yes | file | fan curve file name | yes |
outOfBounds | out of bounds handling | yes | outOfBounds | out of bounds handling | yes |
direction | direction of flow through fan [in/out] | yes | direction | direction of flow through fan [in/out] | yes |
p0 | environmental total pressure | yes | p0 | environmental total pressure | yes |
@ -45,7 +45,7 @@ Usage
inlet inlet
{ {
type fanPressure; type fanPressure;
fileName "fanCurve"; file "fanCurve";
outOfBounds clamp; outOfBounds clamp;
direction in; direction in;
p0 uniform 0; p0 uniform 0;
@ -55,7 +55,7 @@ Usage
outlet outlet
{ {
type fanPressure; type fanPressure;
fileName "fanCurve"; file "fanCurve";
outOfBounds clamp; outOfBounds clamp;
direction out; direction out;
p0 uniform 0; p0 uniform 0;

6
src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -43,7 +43,7 @@ Usage
<patchName> <patchName>
{ {
type fixedProfile; type fixedProfile;
profile csvFile; profile csvFile;
profileCoeffs profileCoeffs
{ {
@ -52,7 +52,7 @@ Usage
componentColumns (1 2 3); // Component column indices componentColumns (1 2 3); // Component column indices
separator ","; // Optional (defaults to ",") separator ","; // Optional (defaults to ",")
mergeSeparators no; // Merge multiple separators mergeSeparators no; // Merge multiple separators
fileName "Uprofile.csv"; // name of csv data file file "Uprofile.csv"; // name of csv data file
outOfBounds clamp; // Optional out-of-bounds handling outOfBounds clamp; // Optional out-of-bounds handling
interpolationScheme linear; // Optional interpolation scheme interpolationScheme linear; // Optional interpolation scheme
} }

4
src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -34,7 +34,7 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
valueFraction | fraction od value used for boundary [0-1] | yes | valueFraction | fraction of value used for boundary [0-1] | yes |
\endtable \endtable
Example of the boundary condition specification: Example of the boundary condition specification:

4
src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.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 | \\ / O peration |
\\ / A nd | Copyright (C) 2013-2017 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -75,7 +75,7 @@ Usage
primaryInletT 293; primaryInletT 293;
faceZone facesZoneInletOriented; faceZone facesZoneInletOriented;
outOfBounds clamp; outOfBounds clamp;
fileName "effTable"; file "effTable";
} }
\endverbatim \endverbatim