Commit 7b9fde84 authored by Mark Olesen's avatar Mark Olesen
Browse files

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

- purely cosmetic (documentation) changes
parent f55b15e3
......@@ -36,9 +36,9 @@ Description
Usage
\table
Property | Description | Required | Default value
kappa | thermal conductivity option | yes |
Cp | Heat capacity [J/Kg K]] | yes |
mass | Total mass [Kg] | yes |
kappaMethod | thermal conductivity option | yes |
Cp | Heat capacity [J/kg.K] | yes |
mass | Total mass [kg] | yes |
\endtable
Example of the boundary condition specification:
......@@ -47,7 +47,7 @@ Usage
{
type lumpedMassWallTemperature;
kappaMethod fluidThermo;
kappaName none;
kappa none;
mass 1000;
Cp 4100;
value uniform 300.0;
......@@ -86,7 +86,7 @@ private:
//- Specifc heat capacity [J/kg/K]
scalar Cp_;
//- Mass / [kg]
//- Mass [kg]
scalar mass_;
//- Current time index (used for updating)
......
......@@ -204,10 +204,10 @@ Foam::tmp<Foam::scalarField> Foam::temperatureCoupledBase::kappa
<< "Did not find field " << kappaName_
<< " on mesh " << mesh.name() << " patch " << patch_.name()
<< nl
<< "Please set 'kappa' to one of "
<< "Please set 'kappaMethod' to one of "
<< KMethodTypeNames_.toc()
<< " and 'kappaName' to the name of the volScalar"
<< " or volSymmTensor field (if kappa=lookup)"
<< " and 'kappa' to the name of the volScalar"
<< " or volSymmTensor field (if kappaMethod=lookup)"
<< exit(FatalError);
}
......@@ -218,9 +218,10 @@ Foam::tmp<Foam::scalarField> Foam::temperatureCoupledBase::kappa
{
FatalErrorInFunction
<< "Unimplemented method " << KMethodTypeNames_[method_] << nl
<< "Please set 'kappa' to one of " << KMethodTypeNames_.toc()
<< " and 'kappaName' to the name of the volScalar"
<< " or volSymmTensor field (if kappa=lookup)"
<< "Please set 'kappaMethod' to one of "
<< KMethodTypeNames_.toc()
<< " and 'kappa' to the name of the volScalar"
<< " or volSymmTensor field (if kappaMethod=lookup)"
<< exit(FatalError);
}
}
......
......@@ -71,7 +71,7 @@ flowRateInletVelocityFvPatchVectorField
{
volumetric_ = false;
flowRate_ = Function1<scalar>::New("massFlowRate", dict);
rhoName_ = word(dict.lookupOrDefault<word>("rho", "rho"));
rhoName_ = dict.lookupOrDefault<word>("rho", "rho");
}
else
{
......
......@@ -79,8 +79,8 @@ Foam::tmp<Foam::volScalarField> Foam::functionObjects::pressure::rhoScale
FatalErrorInFunction
<< type() << " " << name() << ": "
<< "pressure identified as incompressible, but reference "
<< "density is not set. Please set rhoName to rhoInf, and "
<< "set an appropriate value for rhoInf"
<< "density is not set. Please set 'rho' to 'rhoInf', and "
<< "set an appropriate value for 'rhoInf'"
<< exit(FatalError);
}
......
......@@ -34,9 +34,9 @@ Description
{
type filmPyrolysisRadiativeCoupledMixed;
Tnbr T;
kappa fluidThermo;
kappaMethod fluidThermo;
kappa none;
Qr Qr;
kappaName none;
filmDeltaDry 0.0;
filmDeltaWet 3e-4;
value $internalField;
......@@ -66,7 +66,7 @@ Description
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.
......
......@@ -52,8 +52,8 @@ Usage
// Underlaying coupled boundary condition
Tnbr T;
kappa fluidThermo; // or solidThermo
KappaName none;
kappaMethod fluidThermo; // or solidThermo
kappa none;
QrNbr Qr;//or none.Name of Qr field on neighbourregion
Qr none;// or none.Name of Qr field on localregion
value uniform 300;
......@@ -122,8 +122,8 @@ Usage
<slavePatchName>
{
type compressible::thermalBaffle;
kappa fluidThermo;
kappaName none;
kappaMethod fluidThermo;
kappa none;
value uniform 300;
\endverbatim
......@@ -132,16 +132,16 @@ Usage
bottom
{
type compressible::thermalBaffle;
kappa solidThermo;
kappaName none;
kappaMethod solidThermo;
kappa none;
value uniform 300;
}
top
{
type compressible::thermalBaffle;
kappa solidThermo;
kappaName none;
kappaMethod solidThermo;
kappa none;
value uniform 300;
}
\endverbatim
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2015-2016 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -22,7 +22,6 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::
compressible::
humidityTemperatureCoupledMixedFvPatchScalarField
......@@ -94,8 +93,8 @@ Description
myInterfacePatchName
{
type thermalHumidityCoupledMixed;
kappa fluidThermo;
kappaName none;
kappaMethod fluidThermo;
kappa none;
// Modes of operation: inert, condensation, vaporization, condEvap
mode condEvap;
......@@ -137,8 +136,8 @@ Description
myInterfacePatchName
{
type thermalInertiaMassTransferCoupledMixed;
kappa solidThermo;
kappaName none;
kappaMethod solidThermo;
kappa none;
value uniform 260;
}
\endverbatim
......
......@@ -30,10 +30,10 @@ boundaryField
{
type lumpedMassWallTemperature;
kappaMethod fluidThermo;
kappaName none;
kappa none;
mass 1000;
Cp 4100;
value uniform 300.0;
value uniform 300;
}
fixedWalls
......@@ -42,4 +42,5 @@ boundaryField
}
}
// ************************************************************************* //
/*--------------------------------*- 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;
}
}
// ************************************************************************* //
......@@ -5,6 +5,6 @@ cd ${0%/*} || exit 1 # Run from this directory
. $WM_PROJECT_DIR/bin/tools/CleanFunctions
cleanCase
\cp 0/T.orig 0/T
rm -rf 0
#------------------------------------------------------------------------------
......@@ -4,11 +4,11 @@ cd ${0%/*} || exit 1 # Run from this directory
# Source tutorial run functions
. $WM_PROJECT_DIR/bin/tools/RunFunctions
# Get application name
application=$(getApplication)
runApplication blockMesh
restore0Dir
runApplication setFields
runApplication $application
runApplication $(getApplication)
#------------------------------------------------------------------------------
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment