STYLE: Updated header description

This commit is contained in:
andy
2012-05-30 15:27:09 +01:00
parent c34efdac09
commit 75459f1316

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 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -36,8 +36,8 @@ Description
The flow/wave speed at the outlet is provided by the virtual function The flow/wave speed at the outlet is provided by the virtual function
advectionSpeed() the default implementation of which requires the name of advectionSpeed() the default implementation of which requires the name of
flux field a the outlet (phi) and optionally the density (rho) if the the flux field (phi) and optionally the density (rho) if the mass-flux
mass-flux rather than the volumetric-flux is given. rather than the volumetric-flux is given.
\verbatim \verbatim
outlet outlet
{ {
@ -50,7 +50,7 @@ Description
\endverbatim \endverbatim
The flow/wave speed at the outlet can be changed by deriving a specialised The flow/wave speed at the outlet can be changed by deriving a specialised
BC fron this class and overriding advectionSpeed() e.g. in BC from this class and overriding advectionSpeed() e.g. in
waveTransmissiveFvPatchField the advectionSpeed() calculates and returns waveTransmissiveFvPatchField the advectionSpeed() calculates and returns
the flow-speed plus the acoustic wave speed creating an acoustic wave the flow-speed plus the acoustic wave speed creating an acoustic wave
transmissive boundary condition. transmissive boundary condition.