From 567fc9049250901def7c3fb5c3e37a0a02c1e721 Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Tue, 22 May 2018 22:30:46 +0100 Subject: [PATCH] Corrected "fileName" -> "file" in header documentation Patch contributed by Bruno Santos Resolves bug-report https://bugs.openfoam.org/view.php?id=2951 --- applications/utilities/postProcessing/noise/noise.C | 2 +- .../interpolationTable/interpolationTable.H | 4 ++-- src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H | 2 +- .../primitives/functions/Function1/TableFile/TableFile.H | 4 ++-- .../externalCoupledTemperatureMixedFvPatchScalarField.H | 6 +++--- src/engine/engineTime/freePiston/freePiston.H | 4 ++-- .../externalCoupledMixedFvPatchField.H | 6 +++--- .../fields/fvPatchFields/derived/fan/fanFvPatchField.H | 2 +- .../derived/fanPressure/fanPressureFvPatchScalarField.H | 8 ++++---- .../derived/fixedProfile/fixedProfileFvPatchField.H | 6 +++--- .../derived/partialSlip/partialSlipFvPatchField.H | 4 ++-- .../effectivenessHeatExchangerSource.H | 2 +- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C index c27da7f8f..435d7f4f5 100644 --- a/applications/utilities/postProcessing/noise/noise.C +++ b/applications/utilities/postProcessing/noise/noise.C @@ -43,7 +43,7 @@ Usage pressureData { - fileName "pressureData" + file "pressureData"; nHeaderLine 1; // number of header lines refColumn 0; // reference column index componentColumns (1); // component column indices diff --git a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H index 6ba129558..53c49d854 100644 --- a/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H +++ b/src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -42,7 +42,7 @@ Description Read csv format: \verbatim readerType csv; - fileName "$FOAM_CASE/constant/p0vsTime.csv"; + file "$FOAM_CASE/constant/p0vsTime.csv"; hasHeaderLine true; // skip first line timeColumn 0; // time is in column 0 valueColumns (1); // value starts in column 1 diff --git a/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H b/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H index 638ef5aec..1f60d249f 100644 --- a/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H +++ b/src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H @@ -39,7 +39,7 @@ Description componentColumns (1 2 3); // component column indices separator ","; // optional (defaults to ",") 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 interpolationScheme linear; // optional interpolation scheme } diff --git a/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H b/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H index 8d570b14d..6a19493a1 100644 --- a/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H +++ b/src/OpenFOAM/primitives/functions/Function1/TableFile/TableFile.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -32,7 +32,7 @@ Description tableFile; Coeffs { - fileName dataFile; // name of data file + file dataFile; // name of data file outOfBounds clamp; // optional out-of-bounds handling interpolationScheme linear; // optional interpolation method } diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H index 42e3efa01..72f8ab615 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013-2017 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -87,7 +87,7 @@ Usage \table Property | Description | Required | Default value commsDir | communications directory | yes | - fileName | transfer file name | yes | + file | transfer file name | yes | waitInterval | interval [s] between file checks | no | 1 timeOut | time after which error invoked [s] |no |100*waitInterval calcFrequency | calculation frequency | no | 1 @@ -100,7 +100,7 @@ Usage { type externalCoupledTemperature; commsDir "$FOAM_CASE/comms"; - fileName data; + file data; calcFrequency 1; } \endverbatim diff --git a/src/engine/engineTime/freePiston/freePiston.H b/src/engine/engineTime/freePiston/freePiston.H index 47fff4348..33dc04c7e 100644 --- a/src/engine/engineTime/freePiston/freePiston.H +++ b/src/engine/engineTime/freePiston/freePiston.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2017 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -42,7 +42,7 @@ Description pistonPositionTime tableFile; pistonPositionTimeCoeffs { - fileName "data"; + file "data"; outOfBounds clamp; interpolationScheme linear; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H index 690e74df4..5846478a0 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2013-2017 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -87,7 +87,7 @@ Usage \table Property | Description | Required | Default value commsDir | communications directory | yes | - fileName | transfer file name | yes | + file | transfer file name | yes | waitInterval | interval [s] between file checks | no | 1 timeOut | time after which error invoked [s] |no |100*waitInterval calcFrequency | calculation frequency | no | 1 @@ -101,7 +101,7 @@ Usage { type externalCoupled; commsDir "$FOAM_CASE/comms"; - fileName data; + file data; calcFrequency 1; initByExternal yes; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 84928f9fb..65a0cd9ee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -56,7 +56,7 @@ Usage refColumn 0; componentColumns 1(1); separator ","; - fileName "$FOAM_CASE/constant/pressureVsU"; + file "$FOAM_CASE/constant/pressureVsU"; } value uniform 0; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index aa4b19f28..1d00c5697 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -34,7 +34,7 @@ Description Usage \table Property | Description | Required | Default value - fileName | fan curve file name | yes | + file | fan curve file name | yes | outOfBounds | out of bounds handling | yes | direction | direction of flow through fan [in/out] | yes | p0 | environmental total pressure | yes | @@ -45,7 +45,7 @@ Usage inlet { type fanPressure; - fileName "fanCurve"; + file "fanCurve"; outOfBounds clamp; direction in; p0 uniform 0; @@ -55,7 +55,7 @@ Usage outlet { type fanPressure; - fileName "fanCurve"; + file "fanCurve"; outOfBounds clamp; direction out; p0 uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H index 502be93b5..c955eaf83 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2015-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -43,7 +43,7 @@ Usage { type fixedProfile; - profile csvFile; + profile csvFile; profileCoeffs { @@ -52,7 +52,7 @@ Usage componentColumns (1 2 3); // Component column indices separator ","; // Optional (defaults to ",") 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 interpolationScheme linear; // Optional interpolation scheme } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index fb8d75056..e1374903f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -34,7 +34,7 @@ Description Usage \table 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 Example of the boundary condition specification: diff --git a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H index 389a2810d..0e2c514f9 100644 --- a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H +++ b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H @@ -75,7 +75,7 @@ Usage primaryInletT 293; faceZone facesZoneInletOriented; outOfBounds clamp; - fileName "effTable"; + file "effTable"; } \endverbatim