STYLE: consistent naming of 'kappa' instead of 'kappaName' etc (issue #305)

- purely cosmetic (documentation) changes
This commit is contained in:
Mark Olesen
2016-11-20 11:41:52 +01:00
parent f55b15e387
commit 7b9fde84ce
18 changed files with 39 additions and 83 deletions

View File

@ -36,9 +36,9 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
kappa | thermal conductivity option | yes | kappaMethod | thermal conductivity option | yes |
Cp | Heat capacity [J/Kg K]] | yes | Cp | Heat capacity [J/kg.K] | yes |
mass | Total mass [Kg] | yes | mass | Total mass [kg] | yes |
\endtable \endtable
Example of the boundary condition specification: Example of the boundary condition specification:
@ -47,7 +47,7 @@ Usage
{ {
type lumpedMassWallTemperature; type lumpedMassWallTemperature;
kappaMethod fluidThermo; kappaMethod fluidThermo;
kappaName none; kappa none;
mass 1000; mass 1000;
Cp 4100; Cp 4100;
value uniform 300.0; value uniform 300.0;
@ -86,7 +86,7 @@ private:
//- Specifc heat capacity [J/kg/K] //- Specifc heat capacity [J/kg/K]
scalar Cp_; scalar Cp_;
//- Mass / [kg] //- Mass [kg]
scalar mass_; scalar mass_;
//- Current time index (used for updating) //- Current time index (used for updating)

View File

@ -204,10 +204,10 @@ Foam::tmp<Foam::scalarField> Foam::temperatureCoupledBase::kappa
<< "Did not find field " << kappaName_ << "Did not find field " << kappaName_
<< " on mesh " << mesh.name() << " patch " << patch_.name() << " on mesh " << mesh.name() << " patch " << patch_.name()
<< nl << nl
<< "Please set 'kappa' to one of " << "Please set 'kappaMethod' to one of "
<< KMethodTypeNames_.toc() << KMethodTypeNames_.toc()
<< " and 'kappaName' to the name of the volScalar" << " and 'kappa' to the name of the volScalar"
<< " or volSymmTensor field (if kappa=lookup)" << " or volSymmTensor field (if kappaMethod=lookup)"
<< exit(FatalError); << exit(FatalError);
} }
@ -218,9 +218,10 @@ Foam::tmp<Foam::scalarField> Foam::temperatureCoupledBase::kappa
{ {
FatalErrorInFunction FatalErrorInFunction
<< "Unimplemented method " << KMethodTypeNames_[method_] << nl << "Unimplemented method " << KMethodTypeNames_[method_] << nl
<< "Please set 'kappa' to one of " << KMethodTypeNames_.toc() << "Please set 'kappaMethod' to one of "
<< " and 'kappaName' to the name of the volScalar" << KMethodTypeNames_.toc()
<< " or volSymmTensor field (if kappa=lookup)" << " and 'kappa' to the name of the volScalar"
<< " or volSymmTensor field (if kappaMethod=lookup)"
<< exit(FatalError); << exit(FatalError);
} }
} }

View File

@ -71,7 +71,7 @@ flowRateInletVelocityFvPatchVectorField
{ {
volumetric_ = false; volumetric_ = false;
flowRate_ = Function1<scalar>::New("massFlowRate", dict); flowRate_ = Function1<scalar>::New("massFlowRate", dict);
rhoName_ = word(dict.lookupOrDefault<word>("rho", "rho")); rhoName_ = dict.lookupOrDefault<word>("rho", "rho");
} }
else else
{ {

View File

@ -79,8 +79,8 @@ Foam::tmp<Foam::volScalarField> Foam::functionObjects::pressure::rhoScale
FatalErrorInFunction FatalErrorInFunction
<< type() << " " << name() << ": " << type() << " " << name() << ": "
<< "pressure identified as incompressible, but reference " << "pressure identified as incompressible, but reference "
<< "density is not set. Please set rhoName to rhoInf, and " << "density is not set. Please set 'rho' to 'rhoInf', and "
<< "set an appropriate value for rhoInf" << "set an appropriate value for 'rhoInf'"
<< exit(FatalError); << exit(FatalError);
} }

View File

@ -34,9 +34,9 @@ Description
{ {
type filmPyrolysisRadiativeCoupledMixed; type filmPyrolysisRadiativeCoupledMixed;
Tnbr T; Tnbr T;
kappa fluidThermo; kappaMethod fluidThermo;
kappa none;
Qr Qr; Qr Qr;
kappaName none;
filmDeltaDry 0.0; filmDeltaDry 0.0;
filmDeltaWet 3e-4; filmDeltaWet 3e-4;
value $internalField; value $internalField;
@ -66,7 +66,7 @@ Description
Notes: Notes:
- kappa and \c kappaName are inherited from temperatureCoupledBase. - \c kappaMethod and \c kappa are inherited from temperatureCoupledBase.
- Qr is the radiative flux defined in the radiation model. - Qr is the radiative flux defined in the radiation model.

View File

@ -52,8 +52,8 @@ Usage
// Underlaying coupled boundary condition // Underlaying coupled boundary condition
Tnbr T; Tnbr T;
kappa fluidThermo; // or solidThermo kappaMethod fluidThermo; // or solidThermo
KappaName none; kappa none;
QrNbr Qr;//or none.Name of Qr field on neighbourregion QrNbr Qr;//or none.Name of Qr field on neighbourregion
Qr none;// or none.Name of Qr field on localregion Qr none;// or none.Name of Qr field on localregion
value uniform 300; value uniform 300;
@ -122,8 +122,8 @@ Usage
<slavePatchName> <slavePatchName>
{ {
type compressible::thermalBaffle; type compressible::thermalBaffle;
kappa fluidThermo; kappaMethod fluidThermo;
kappaName none; kappa none;
value uniform 300; value uniform 300;
\endverbatim \endverbatim
@ -132,16 +132,16 @@ Usage
bottom bottom
{ {
type compressible::thermalBaffle; type compressible::thermalBaffle;
kappa solidThermo; kappaMethod solidThermo;
kappaName none; kappa none;
value uniform 300; value uniform 300;
} }
top top
{ {
type compressible::thermalBaffle; type compressible::thermalBaffle;
kappa solidThermo; kappaMethod solidThermo;
kappaName none; kappa none;
value uniform 300; value uniform 300;
} }
\endverbatim \endverbatim

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 OpenCFD Ltd. \\ / A nd | Copyright (C) 2015-2016 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,6 @@ 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:: Foam::
compressible:: compressible::
humidityTemperatureCoupledMixedFvPatchScalarField humidityTemperatureCoupledMixedFvPatchScalarField
@ -94,8 +93,8 @@ Description
myInterfacePatchName myInterfacePatchName
{ {
type thermalHumidityCoupledMixed; type thermalHumidityCoupledMixed;
kappa fluidThermo; kappaMethod fluidThermo;
kappaName none; kappa none;
// Modes of operation: inert, condensation, vaporization, condEvap // Modes of operation: inert, condensation, vaporization, condEvap
mode condEvap; mode condEvap;
@ -137,8 +136,8 @@ Description
myInterfacePatchName myInterfacePatchName
{ {
type thermalInertiaMassTransferCoupledMixed; type thermalInertiaMassTransferCoupledMixed;
kappa solidThermo; kappaMethod solidThermo;
kappaName none; kappa none;
value uniform 260; value uniform 260;
} }
\endverbatim \endverbatim

View File

@ -30,10 +30,10 @@ boundaryField
{ {
type lumpedMassWallTemperature; type lumpedMassWallTemperature;
kappaMethod fluidThermo; kappaMethod fluidThermo;
kappaName none; kappa none;
mass 1000; mass 1000;
Cp 4100; Cp 4100;
value uniform 300.0; value uniform 300;
} }
fixedWalls fixedWalls
@ -42,4 +42,5 @@ boundaryField
} }
} }
// ************************************************************************* // // ************************************************************************* //

View File

@ -1,45 +0,0 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: plus |
| \\ / A nd | Web: www.OpenFOAM.com |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
FoamFile
{
version 2.0;
format ascii;
class volScalarField;
object T;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
dimensions [0 0 0 1 0 0 0];
internalField uniform 300;
boundaryField
{
floor
{
type fixedValue;
value uniform 300;
}
ceiling
{
type lumpedMassWallTemperature;
kappaMethod fluidThermo;
kappaName none;
mass 1000;
Cp 4100;
value uniform 300.0;
}
fixedWalls
{
type zeroGradient;
}
}
// ************************************************************************* //

View File

@ -5,6 +5,6 @@ cd ${0%/*} || exit 1 # Run from this directory
. $WM_PROJECT_DIR/bin/tools/CleanFunctions . $WM_PROJECT_DIR/bin/tools/CleanFunctions
cleanCase cleanCase
\cp 0/T.orig 0/T rm -rf 0
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------

View File

@ -4,11 +4,11 @@ cd ${0%/*} || exit 1 # Run from this directory
# Source tutorial run functions # Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions . $WM_PROJECT_DIR/bin/tools/RunFunctions
# Get application name
application=$(getApplication)
runApplication blockMesh runApplication blockMesh
restore0Dir
runApplication setFields runApplication setFields
runApplication $application runApplication $(getApplication)
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------