zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Doxygen documentation and files

Browse Source 
Contributed by Bruno Santos
Resolves patch report http://www.openfoam.org/mantisbt/view.php?id=2023

Update online documentation http://openfoam.github.io/Documentation-dev/html/
This commit is contained in:
Henry Weller
2016-03-14 11:00:24 +00:00
parent b4ebcd770f
commit e57874859a
52 changed files with 456 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.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-2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -33,7 +33,7 @@ Description
This boundary condition provides a fixed density inlet condition for This boundary condition provides a fixed density inlet condition for
compressible solvers, where the density of calculated using: compressible solvers, where the density of calculated using:
\f{ \f[
\rho = \psi p \rho = \psi p
\f] \f]

2
applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
View File

@ -35,7 +35,7 @@ Usage
\param -ascii \n \param -ascii \n
Write Ensight data in ASCII format instead of "C Binary" Write Ensight data in ASCII format instead of "C Binary"
\parm -name \<subdir\>\n \param -name \<subdir\>\n
define sub-directory name to use for Ensight data (default: "Ensight") define sub-directory name to use for Ensight data (default: "Ensight")
\param -noZero \n \param -noZero \n

6
doc/Doxygen/_Header
View File

@ -2,15 +2,19 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UFT-8"/> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title> OpenFOAM&reg; Programmer's C++ documentation </title> <title> OpenFOAM&reg; Programmer's C++ documentation </title>
<!-- links --> <!-- links -->
<link href="../OpenFOAMdocIcon.png" rel="icon" type="image/png" /> <link href="../OpenFOAMdocIcon.png" rel="icon" type="image/png" />
<link href="search/search.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css" />
<link href="../css/openfoam.css" rel="stylesheet" type="text/css" /> <link href="../css/openfoam.css" rel="stylesheet" type="text/css" />
<script type="text/javaScript" src="search/searchdata.js"></script>
<script type="text/javaScript" src="search/search.js"></script> <script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script> <script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<!-- meta info --> <!-- meta info -->
<meta <meta

7
doc/Doxygen/css/cfdLayout.css
View File

@ -11,6 +11,11 @@ body {
font-size: 62.5%; font-size: 62.5%;
} /*Font-size: 1.0em = 10px when browser default size is 16px*/ } /*Font-size: 1.0em = 10px when browser default size is 16px*/
/* Using the same as the code/verbatim blocks in doxygen.css */
code {
font-family: "Courier New", Courier, monospace, fixed;
}
p:after { p:after {
content:"."; content:".";
display:block; display:block;
@ -243,7 +248,7 @@ p:after {
padding-bottom:30px; padding-bottom:30px;
border-left: 3px solid rgb(175,175,175); border-left: 3px solid rgb(175,175,175);
border-right:3px solid rgb(175,175,175); border-right:3px solid rgb(175,175,175);
background:transparent url(img/bg_main.gif) top left repeat-y; background:transparent;
} }
.main img { .main img {
clear:both; clear:both;

2
src/OpenFOAM/db/IOstreams/Pstreams/Pstream.H
View File

@ -25,7 +25,7 @@ Class
Foam::Pstream Foam::Pstream
Description Description
Inter-processor communications stream Inter-processor communications stream.
SourceFiles SourceFiles
Pstream.C Pstream.C

8
src/OpenFOAM/db/IOstreams/Pstreams/PstreamReduceOps.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamespace
Foam
Description
Inter-processor communication reduction functions.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef PstreamReduceOps_H #ifndef PstreamReduceOps_H

7
src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.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-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -110,12 +110,15 @@ public:
//- Construct from Time, a dictionary with "functions" entry //- Construct from Time, a dictionary with "functions" entry
// and the execution setting. // and the execution setting.
// \param[in] t - the other Time instance to construct from
// \param[in] parentDict - the parent dictionary containing // \param[in] parentDict - the parent dictionary containing
// a "functions" entry, which can either be a list or a dictionary // a "functions" entry, which can either be a list or a dictionary
// of functionObject specifications. // of functionObject specifications.
// \param[in] execution - whether the function objects should execute
// or not. Default: true.
functionObjectList functionObjectList
( (
const Time&, const Time& t,
const dictionary& parentDict, const dictionary& parentDict,
const bool execution=true const bool execution=true
); );

2
src/OpenFOAM/fields/FieldFields/FieldField/FieldFieldFunctions.C
View File

@ -543,8 +543,6 @@ Type average(const FieldField<Field, Type>& f)
TMP_UNARY_FUNCTION(Type, average) TMP_UNARY_FUNCTION(Type, average)
#include "PstreamReduceOps.H"
#define G_UNARY_FUNCTION(returnType, gFunc, func, rFunc) \ #define G_UNARY_FUNCTION(returnType, gFunc, func, rFunc) \
\ \
template<template<class> class Field, class Type> \ template<template<class> class Field, class Type> \

2
src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H
View File

@ -57,7 +57,7 @@ Description
} }
\endverbatim \endverbatim
A special form is if the 'code' section is not supplied. In this case A special form is if the \c code section is not supplied. In this case
the code gets read from a (runTimeModifiable!) dictionary system/codeDict the code gets read from a (runTimeModifiable!) dictionary system/codeDict
which would have a corresponding entry which would have a corresponding entry

8
src/OpenFOAM/global/debug/debug.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -41,7 +41,9 @@ namespace Foam
namespace debug namespace debug
{ {
//! \cond ignoreDocumentation - local scope //! \cond ignoreDocumentation
//- Skip documentation : local scope only
dictionary* controlDictPtr_(NULL); dictionary* controlDictPtr_(NULL);
dictionary* debugSwitchesPtr_(NULL); dictionary* debugSwitchesPtr_(NULL);
dictionary* infoSwitchesPtr_(NULL); dictionary* infoSwitchesPtr_(NULL);
@ -55,7 +57,7 @@ simpleObjectRegistry* dimensionSetObjectsPtr_(NULL);
simpleObjectRegistry* dimensionedConstantObjectsPtr_(NULL); simpleObjectRegistry* dimensionedConstantObjectsPtr_(NULL);
// to ensure controlDictPtr_ is deleted at the end of the run // To ensure controlDictPtr_ is deleted at the end of the run
class deleteControlDictPtr class deleteControlDictPtr
{ {
public: public:

5
src/OpenFOAM/graph/curve/curveTools.H
View File

@ -4,6 +4,8 @@
#include "scalar.H" #include "scalar.H"
#include "vector.H" #include "vector.H"
#include "curve.H" #include "curve.H"
#include "char.H"
#include "List.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
@ -13,9 +15,6 @@ namespace Foam
#define curveSmall 1.0e-8 #define curveSmall 1.0e-8
#define curveGreat 1.0e8 #define curveGreat 1.0e8
#include "char.H"
#include "List.H"
typedef List<char> charList; typedef List<char> charList;
typedef List<charList> charListList; typedef List<charList> charListList;

6
src/OpenFOAM/interpolations/interpolationTable/interpolationTable.H
View File

@ -29,9 +29,9 @@ Description
The reference scalar values must be monotonically increasing. The reference scalar values must be monotonically increasing.
The handling of out-of-bounds values depends on the current setting The handling of out-of-bounds values depends on the current setting
of \a outOfBounds. of \c outOfBounds.
If \a REPEAT is chosen for the out-of-bounds handling, the final time If \c repeat is chosen for the out-of-bounds handling, the final time
value is treated as being equivalent to time=0 for the following periods. value is treated as being equivalent to time=0 for the following periods.
@ -40,11 +40,13 @@ Description
other format is csv (comma separated values): other format is csv (comma separated values):
Read csv format: Read csv format:
\verbatim
readerType csv; readerType csv;
fileName "$FOAM_CASE/constant/p0vsTime.csv"; fileName "$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
\endverbatim
Note Note

13
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGAgglomerations/GAMGAgglomeration/GAMGAgglomeration.H
View File

@ -171,10 +171,11 @@ protected:
// Processor agglomeration // Processor agglomeration
//- Collect and combine processor meshes into allMesh. //- Collect and combine processor meshes into allMesh:
//
// - allMeshComm : communicator for combined mesh. // - allMeshComm : communicator for combined mesh.
// - procAgglomMap : per processor the new agglomerated processor // - procAgglomMap : per processor the new agglomerated
// (rank in allMeshComm!). Global information. // processor (rank in allMeshComm!). Global information.
// - procIDs : local information: same for all in // - procIDs : local information: same for all in
// agglomerated processor. // agglomerated processor.
void procAgglomerateLduAddressing void procAgglomerateLduAddressing
@ -187,8 +188,9 @@ protected:
); );
//- Collect and combine basic restriction addressing: //- Collect and combine basic restriction addressing:
// nCells_ //
// restrictAddressing_ // - nCells_
// - restrictAddressing_
void procAgglomerateRestrictAddressing void procAgglomerateRestrictAddressing
( (
const label comm, const label comm,
@ -426,6 +428,7 @@ public:
// with GAMGSolver notation. // with GAMGSolver notation.
//- Given fine to coarse processor map determine: //- Given fine to coarse processor map determine:
//
// - for each coarse processor a master (minimum of the fine // - for each coarse processor a master (minimum of the fine
// processors) // processors)
// - for each coarse processor the set of fine processors // - for each coarse processor the set of fine processors

18
src/OpenFOAM/meshes/MeshObject/MeshObject.H
View File

@ -33,6 +33,7 @@ Description
MoveableMeshObject, UpdateableMeshObject) and the type of the actual object MoveableMeshObject, UpdateableMeshObject) and the type of the actual object
it is created for example: it is created for example:
\verbatim
class leastSquaresVectors class leastSquaresVectors
: :
public MeshObject<fvMesh, MoveableMeshObject, leastSquaresVectors> public MeshObject<fvMesh, MoveableMeshObject, leastSquaresVectors>
@ -43,17 +44,20 @@ Description
//- Delete the least square vectors when the mesh moves //- Delete the least square vectors when the mesh moves
virtual bool movePoints(); virtual bool movePoints();
}; };
\endverbatim
MeshObject types: MeshObject types:
TopologicalMeshObject: mesh object to be deleted on topology change - TopologicalMeshObject: mesh object to be deleted on topology change
GeometricMeshObject: mesh object to be deleted on geometry change - GeometricMeshObject: mesh object to be deleted on geometry change
MoveableMeshObject: mesh object to be updated in movePoints - MoveableMeshObject: mesh object to be updated in movePoints
UpdateableMeshObject: mesh object to be updated in updateMesh or movePoints - UpdateableMeshObject: mesh object to be updated in updateMesh or
movePoints
Note that movePoints must be provided for MeshObjects of type Note
MoveableMeshObject and both movePoints and updateMesh functions must exist movePoints must be provided for MeshObjects of type MoveableMeshObject
provided for MeshObjects of type UpdateableMeshObject. and both movePoints and updateMesh functions must exist, provided for
MeshObjects of type UpdateableMeshObject.
SourceFiles SourceFiles
MeshObject.C MeshObject.C

3
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchTools.H
View File

@ -123,6 +123,7 @@ public:
//- Determine the mapping for a sub-patch. //- Determine the mapping for a sub-patch.
// Only include faces for which bool-list entry is true. // Only include faces for which bool-list entry is true.
// \param[in] p patch to be searched on
// \param[in] includeFaces faces to include // \param[in] includeFaces faces to include
// \param[out] pointMap mapping new to old localPoints // \param[out] pointMap mapping new to old localPoints
// \param[out] faceMap mapping new to old faces // \param[out] faceMap mapping new to old faces
@ -136,7 +137,7 @@ public:
> >
static void subsetMap static void subsetMap
( (
const PrimitivePatch<Face, FaceList, PointField, PointType>&, const PrimitivePatch<Face, FaceList, PointField, PointType>& p,
const BoolListType& includeFaces, const BoolListType& includeFaces,
labelList& pointMap, labelList& pointMap,
labelList& faceMap labelList& faceMap

6
src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.C
View File

@ -44,7 +44,8 @@ const Foam::treeBoundBox Foam::treeBoundBox::invertedBox
); );
//! \cond - skip documentation : local scope only //! \cond ignoreDocumentation
//- Skip documentation : local scope only
const Foam::label facesArray[6][4] = const Foam::label facesArray[6][4] =
{ {
{0, 4, 6, 2}, // left {0, 4, 6, 2}, // left
@ -63,7 +64,8 @@ const Foam::faceList Foam::treeBoundBox::faces
); );
//! \cond - skip documentation : local scope only //! \cond ignoreDocumentation
//- Skip documentation : local scope only
const Foam::label edgesArray[12][2] = const Foam::label edgesArray[12][2] =
{ {
{0, 1}, // 0 {0, 1}, // 0

17
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -62,7 +62,7 @@ Description
type compressible::turbulentTemperatureCoupledBaffleMixed; type compressible::turbulentTemperatureCoupledBaffleMixed;
Tnbr T; Tnbr T;
kappa lookup; kappa lookup;
KappaName kappa; kappaName kappa;
thicknessLayers (0.1 0.2 0.3 0.4); thicknessLayers (0.1 0.2 0.3 0.4);
kappaLayers (1 2 3 4) kappaLayers (1 2 3 4)
value uniform 300; value uniform 300;
@ -71,14 +71,13 @@ Description
Needs to be on underlying mapped(Wall)FvPatch. Needs to be on underlying mapped(Wall)FvPatch.
Note: kappa : heat conduction at patch. Gets supplied how to lookup Note:
calculate kappa:
- 'lookup' : lookup volScalarField (or volSymmTensorField) with name \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
- 'fluidThermo' : use fluidThermo and compressible::RASmodel to calculate
kappa
- 'solidThermo' : use solidThermo kappa() SeeAlso
- 'directionalSolidThermo' directionalKappa() Foam::temperatureCoupledBase
SourceFiles SourceFiles
turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.C turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.C

4
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.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) 2012-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -29,7 +29,7 @@ License
This group contains RAS turbulence model boundary conditions This group contains RAS turbulence model boundary conditions
@} @}
\defgroup grpWallFunctions RAS wall functions \defgroup grpRASWallFunctions RAS wall functions
@{ @{
\ingroup grpRASBoundaryConditions \ingroup grpRASBoundaryConditions
This group contains RAS turbulence model wall functions This group contains RAS turbulence model wall functions

5
src/dynamicMesh/extrudePatchMesh/extrudePatchMesh.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,6 +28,8 @@ Description
Mesh at a patch created on the fly. The following entry should be used Mesh at a patch created on the fly. The following entry should be used
on the field boundary dictionary: on the field boundary dictionary:
Example:
\verbatim
// New Shell mesh data // New Shell mesh data
extrudeModel linearNormal; extrudeModel linearNormal;
@ -61,6 +63,7 @@ Description
name "side"; name "side";
type empty; type empty;
} }
\endverbatim
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

11
src/finiteVolume/cfdTools/general/fvOptions/fvOption.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -25,13 +25,14 @@ Class
Foam::fv::option Foam::fv::option
Description Description
Finite volume options abtract base class. Provides a base set of controls, Finite volume options abstract base class. Provides a base set of
e.g. controls, e.g.:
\verbatim
type scalarExplicitSource // source type type scalarExplicitSource // source type
active on; // on/off switch active on; // on/off switch
\endverbatim
Note: Note
On evaluation, source/sink options are to be added to the equation R.H.S. On evaluation, source/sink options are to be added to the equation R.H.S.
SourceFiles SourceFiles

6
src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -54,7 +54,7 @@ Description
U | velocity U | velocity
\endvartable \endvartable
3. compressible transonic (\gamma <= 1): 3. compressible transonic (\f$\gamma <= 1\f$):
\f[ \f[
p_p = \frac{p_0}{1 + 0.5 \psi |U|^2} p_p = \frac{p_0}{1 + 0.5 \psi |U|^2}
\f] \f]
@ -65,7 +65,7 @@ Description
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$ G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
\endvartable \endvartable
4. compressible supersonic (\gamma > 1): 4. compressible supersonic (\f$\gamma > 1\f$):
\f[ \f[
p_p = \frac{p_0}{(1 + 0.5 \psi G |U|^2)^{\frac{1}{G}}} p_p = \frac{p_0}{(1 + 0.5 \psi G |U|^2)^{\frac{1}{G}}}
\f] \f]

11
src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H
View File

@ -27,8 +27,12 @@ Class
Description Description
Interpolates pre-specified motion. Interpolates pre-specified motion.
Motion specified as pointVectorFields. E.g. Motion specified as pointVectorFields.
\heading Patch usage
Example:
\verbatim
walls walls
{ {
type uniformInterpolatedDisplacement; type uniformInterpolatedDisplacement;
@ -36,9 +40,10 @@ Description
fieldName wantedDisplacement; fieldName wantedDisplacement;
interpolationScheme linear; interpolationScheme linear;
} }
\endverbatim
This will scan the case for 'wantedDisplacement' pointVectorFields This will scan the case for \a wantedDisplacement pointVectorFields
and interpolate those in time (using 'linear' interpolation) to and interpolate those in time (using \c linear interpolation) to
obtain the current displacement. obtain the current displacement.
The advantage of specifying displacement in this way is that it The advantage of specifying displacement in this way is that it
automatically works through decomposePar. automatically works through decomposePar.

9
src/fvOptions/cellSetOption/cellSetOption.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -26,8 +26,8 @@ Class
Description Description
Cell-set options abtract base class. Provides a base set of controls, Cell-set options abtract base class. Provides a base set of controls,
e.g. e.g.:
\verbatim
type scalarExplicitSource // Source type type scalarExplicitSource // Source type
active on; // on/off switch active on; // on/off switch
@ -40,8 +40,9 @@ Description
. .
. .
} }
\endverbatim
Note: Note
Source/sink options are to be added to the equation R.H.S. Source/sink options are to be added to the equation R.H.S.
SourceFiles SourceFiles

8
src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.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) 2012-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -25,10 +25,11 @@ Class
Foam::fv::interRegionExplicitPorositySource Foam::fv::interRegionExplicitPorositySource
Description Description
Inter-region explicit porosity source Inter-region explicit porosity source.
Sources described by, for example using the DarcyForchheimer model: Sources described by, for example using the DarcyForchheimer model:
\verbatim
interRegionExplicitPorositySourceCoeffs interRegionExplicitPorositySourceCoeffs
{ {
type DarcyForchheimer; type DarcyForchheimer;
@ -44,8 +45,9 @@ Description
} }
} }
} }
\endverbatim
Note: Note
The porous region must be selected as a cellZone. The porous region must be selected as a cellZone.
SourceFiles SourceFiles

5
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.H
View File

@ -25,16 +25,17 @@ Class
Foam::ParticleTrap Foam::ParticleTrap
Description Description
Traps particles within a given phase fraction for multi-phase cases Traps particles within a given phase fraction for multi-phase cases.
Model is activated using: Model is activated using:
\verbatim
particleTrap1 particleTrap1
{ {
type particleTrap; type particleTrap;
alphaName alpha; // name volume fraction field alphaName alpha; // name volume fraction field
threshold 0.95; // alpha value below which model is active threshold 0.95; // alpha value below which model is active
} }
\endverbatim
SourceFiles SourceFiles

11
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H
View File

@ -25,14 +25,17 @@ Class
Foam::CellZoneInjection Foam::CellZoneInjection
Description Description
Injection positions specified by a particle number density within a cell set Injection positions specified by a particle number density within a cell
set.
- User specifies \li User specifies:
- Number density of particles in cell set (effective) - Number density of particles in cell set (effective)
- Total mass to inject - Total mass to inject
- Initial parcel velocity - Initial parcel velocity
- Parcel diameters obtained by PDF model
- All parcels introduced at SOI \li Parcel diameters obtained by PDF model
\li All parcels introduced at SOI
SourceFiles SourceFiles
CellZoneInjection.C CellZoneInjection.C

8
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H
View File

@ -25,14 +25,16 @@ Class
Foam::ConeInjection Foam::ConeInjection
Description Description
Multi-point cone injection model Multi-point cone injection model.
- User specifies
\li User specifies:
- time of start of injection - time of start of injection
- list of injector positions and directions (along injection axes) - list of injector positions and directions (along injection axes)
- number of parcels to inject per injector - number of parcels to inject per injector
- parcel velocities - parcel velocities
- inner and outer half-cone angles - inner and outer half-cone angles
- Parcel diameters obtained by distribution model
\li Parcel diameters obtained by distribution model
SourceFiles SourceFiles
ConeInjection.C ConeInjection.C

23
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
View File

@ -25,25 +25,32 @@ Class
Foam::ConeNozzleInjection Foam::ConeNozzleInjection
Description Description
Cone injection Cone injection.
- User specifies \li User specifies:
- time of start of injection - time of start of injection
- injector position - injector position
- direction (along injection axis) - direction (along injection axis)
- parcel flow rate - parcel flow rate
- inner and outer half-cone angles - inner and outer half-cone angles
- Parcel diameters obtained by size distribution model \li Parcel diameters obtained by size distribution model
- Parcel velocity is calculated as: \li Parcel velocity is calculated as:
- Constant velocity:
- Constant velocity \verbatim
U = \<specified by user\> U = \<specified by user\>
- Pressure driven velocity \endverbatim
- Pressure driven velocity:
\verbatim
U = sqrt(2*(Pinj - Pamb)/rho) U = sqrt(2*(Pinj - Pamb)/rho)
- Flow rate and discharge \endverbatim
- Flow rate and discharge:
\verbatim
U = V_dot/(A*Cd) U = V_dot/(A*Cd)
\endverbatim
SourceFiles SourceFiles
ConeNozzleInjection.C ConeNozzleInjection.C

14
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H
View File

@ -27,16 +27,16 @@ Class
Description Description
Injection at specified positions, with the conditions: Injection at specified positions, with the conditions:
- for injection to be allowed \li for injection to be allowed
\verbatim
factor*referenceField[cellI] >= thresholdField[cellI] factor*referenceField[cellI] >= thresholdField[cellI]
\endverbatim
where: where:
- referenceField is the field used to supply the look-up values - \c referenceField is the field used to supply the look-up values
- thresholdField supplies the values beyond which the injection is - \c thresholdField supplies the values beyond which the injection is
permitted permitted.
- limited to a user-supllied number of injections per injector location \li limited to a user-supllied number of injections per injector location
SourceFiles SourceFiles
FieldActivatedInjection.C FieldActivatedInjection.C

14
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/KinematicLookupTableInjection.H
View File

@ -28,19 +28,23 @@ Description
Particle injection sources read from look-up table. Each row corresponds to Particle injection sources read from look-up table. Each row corresponds to
an injection site. an injection site.
\verbatim
( (
(x y z) (u v w) d rho mDot // injector 1 (x y z) (u v w) d rho mDot // injector 1
(x y z) (u v w) d rho mDot // injector 2 (x y z) (u v w) d rho mDot // injector 2
... ...
(x y z) (u v w) d rho mDot // injector N (x y z) (u v w) d rho mDot // injector N
); );
\endverbatim
where: where:
x, y, z = global cartesian co-ordinates [m] \plaintable
u, v, w = global cartesian velocity components [m/s] x, y, z | global cartesian co-ordinates [m]
d = diameter [m] u, v, w | global cartesian velocity components [m/s]
rho = density [kg/m3] d | diameter [m]
mDot = mass flow rate [kg/m3] rho | density [kg/m3]
mDot | mass flow rate [kg/m3]
\endplaintable
SourceFiles SourceFiles
KinematicLookupTableInjection.C KinematicLookupTableInjection.C

11
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H
View File

@ -25,13 +25,16 @@ Class
Foam::ManualInjection Foam::ManualInjection
Description Description
Manual injection Manual injection.
- User specifies
\li User specifies:
- Total mass to inject - Total mass to inject
- Parcel positions in file \c positionsFile - Parcel positions in file \c positionsFile
- Initial parcel velocity - Initial parcel velocity
- Parcel diameters obtained by distribution model
- All parcels introduced at SOI \li Parcel diameters obtained by distribution model
\li All parcels introduced at SOI
SourceFiles SourceFiles
ManualInjection.C ManualInjection.C

12
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H
View File

@ -25,17 +25,17 @@ Class
Foam::PatchFlowRateInjection Foam::PatchFlowRateInjection
Description Description
Patch injection Patch injection, by using patch flow rate to determine concentration and
- uses patch flow rate to determine concentration and velociy velocity.
- User specifies \li User specifies
- Total mass to inject - Total mass to inject
- Name of patch - Name of patch
- Injection duration - Injection duration
- Injection target concentration/carrier volume flow rate - Injection target concentration/carrier volume flow rate
- Initial parcel velocity given by local flow velocity \li Initial parcel velocity given by local flow velocity
- Parcel diameters obtained by distribution model \li Parcel diameters obtained by distribution model
- Parcels injected randomly across the patch \li Parcels injected randomly across the patch
SourceFiles SourceFiles
PatchFlowRateInjection.C PatchFlowRateInjection.C

9
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H
View File

@ -25,15 +25,16 @@ Class
Foam::PatchInjection Foam::PatchInjection
Description Description
Patch injection Patch injection.
- User specifies
\li User specifies:
- Total mass to inject - Total mass to inject
- Name of patch - Name of patch
- Injection duration - Injection duration
- Initial parcel velocity - Initial parcel velocity
- Injection volume flow rate - Injection volume flow rate
- Parcel diameters obtained by distribution model \li Parcel diameters obtained by distribution model
- Parcels injected randomly across the patch \li Parcels injected randomly across the patch
SourceFiles SourceFiles
PatchInjection.C PatchInjection.C

10
src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
View File

@ -26,18 +26,20 @@ Class
Description Description
Wall interaction model. Three choices: Wall interaction model. Three choices:
- rebound - optionally specify elasticity and resitution coefficients
- stick - particles assigined zero velocity \li \c rebound - optionally specify elasticity and restitution coefficients
- escape - remove particle from the domain \li \c stick - particles assigned zero velocity
\li \c escape - remove particle from the domain
Example usage: Example usage:
\verbatim
StandardWallInteractionCoeffs StandardWallInteractionCoeffs
{ {
type rebound; // stick, escape type rebound; // stick, escape
e 1; // optional - elasticity coeff e 1; // optional - elasticity coeff
mu 0; // optional - restitution coeff mu 0; // optional - restitution coeff
} }
\endverbatim
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

21
src/mesh/snappyHexMesh/refinementFeatures/refinementFeatures.H
View File

@ -140,11 +140,12 @@ public:
//- Highest distance of all features //- Highest distance of all features
scalar maxDistance() const; scalar maxDistance() const;
//- Find nearest point on nearest feature edge. Sets //- Find nearest point on nearest feature edge. Sets:
//
// - nearFeature: index of feature mesh // - nearFeature: index of feature mesh
// - nearInfo : location on feature edge and edge index // - nearInfo : location on feature edge and edge index
// (note: not feature edge index but index into // (note: not feature edge index but index into edges()
// edges() directly) // directly)
// - nearNormal : local feature edge normal // - nearNormal : local feature edge normal
void findNearestEdge void findNearestEdge
( (
@ -155,11 +156,12 @@ public:
vectorField& nearNormal vectorField& nearNormal
) const; ) const;
//- Find nearest point on nearest region edge. Sets //- Find nearest point on nearest region edge. Sets:
//
// - nearFeature: index of feature mesh // - nearFeature: index of feature mesh
// - nearInfo : location on feature edge and edge index // - nearInfo : location on feature edge and edge index
// (note: not feature edge index but index into // (note: not feature edge index but index into edges()
// edges() directly) // directly)
// - nearNormal : local feature edge normal // - nearNormal : local feature edge normal
void findNearestRegionEdge void findNearestRegionEdge
( (
@ -170,11 +172,12 @@ public:
vectorField& nearNormal vectorField& nearNormal
) const; ) const;
//- Find nearest feature point. Sets //- Find nearest feature point. Sets:
//
// - nearFeature: index of feature mesh // - nearFeature: index of feature mesh
// - nearInfo : location on feature point and point index. // - nearInfo : location on feature point and point index.
// (note: not index into shapes().pointLabels() but // (note: not index into shapes().pointLabels() but index
// index into points() directly) // into points() directly)
void findNearestPoint void findNearestPoint
( (
const pointField& samples, const pointField& samples,

10
src/mesh/snappyHexMesh/snappyHexMeshDriver/layerParameters/layerParameters.H
View File

@ -60,6 +60,7 @@ public:
// Public data types // Public data types
//- Enumeration defining the layer specification: //- Enumeration defining the layer specification:
//
// - first and total thickness specified // - first and total thickness specified
// - first and expansion ratio specified // - first and expansion ratio specified
// - final and total thickness specified // - final and total thickness specified
@ -166,11 +167,12 @@ public:
// Per patch information // Per patch information
//- How many layers to add. //- How many layers to add:
// -1 : no specification. Assume 0 layers but allow sliding //
// - -1 : no specification. Assume 0 layers but allow sliding
// to make layers // to make layers
// 0 : specified to have 0 layers. No sliding allowed. // - 0 : specified to have 0 layers. No sliding allowed.
// >0 : number of layers // - >0 : number of layers
const labelList& numLayers() const const labelList& numLayers() const
{ {
return numLayers_; return numLayers_;

5
src/meshTools/coordinateSystems/coordinateRotation/EulerCoordinateRotation.H
View File

@ -39,12 +39,15 @@ Description
\verbatim \verbatim
coordinateRotation coordinateRotation
{ {
type EulerRotation type EulerRotation;
degrees false; degrees false;
rotation (0 0 3.141592654); rotation (0 0 3.141592654);
} }
\endverbatim \endverbatim
SourceFiles
EulerCoordinateRotation.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef EulerCoordinateRotation_H #ifndef EulerCoordinateRotation_H

3
src/meshTools/coordinateSystems/coordinateRotation/STARCDCoordinateRotation.H
View File

@ -42,6 +42,9 @@ Description
} }
\endverbatim \endverbatim
SourceFiles
STARCDCoordinateRotation.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef STARCDCoordinateRotation_H #ifndef STARCDCoordinateRotation_H

6
src/meshTools/coordinateSystems/coordinateRotation/axesRotation.H
View File

@ -28,7 +28,8 @@ Description
A coordinate rotation specified using global axis A coordinate rotation specified using global axis
The rotation is defined by a combination of vectors (e1/e2), (e2/e3) The rotation is defined by a combination of vectors (e1/e2), (e2/e3)
or (e3/e1). Any nonorthogonality will be absorbed into the second vector. or (e3/e1). Any nonorthogonality will be absorbed into the second
vector.
\verbatim \verbatim
axesRotation axesRotation
@ -39,6 +40,9 @@ Description
} }
\endverbatim \endverbatim
SourceFiles
axesRotation.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef axesRotation_H #ifndef axesRotation_H

13
src/meshTools/coordinateSystems/coordinateRotation/coordinateRotation.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -37,12 +37,15 @@ Description
\endverbatim \endverbatim
Types of coordinateRotation: Types of coordinateRotation:
1) axesRotation
2) STARCDRotation
3) cylindrical
4) EulerCoordinateRotation
\li 1. axesRotation
\li 2. STARCDRotation
\li 3. cylindrical
\li 4. EulerCoordinateRotation
SourceFiles
coordinateRotation.C
coordinateRotationNew.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

12
src/meshTools/coordinateSystems/coordinateRotation/cylindrical.H
View File

@ -28,11 +28,10 @@ Description
A local coordinate rotation. A local coordinate rotation.
The cell based rotational field can be created in two ways: The cell based rotational field can be created in two ways:
1) Each rotational tensor is defined with two vectors (dir and e3) \li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3)
where dir = cellC - origin and e3 is the rotation axis. where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
Per each cell an axesRotation type of rotation is created Per each cell an axesRotation type of rotation is created
(cylindrical coordinates) (cylindrical coordinates). For example:
\verbatim \verbatim
cylindrical cylindrical
{ {
@ -41,7 +40,10 @@ Description
} }
\endverbatim \endverbatim
2) The rotational tensor field is provided at construction \li 2. The rotational tensor field is provided at construction.
SourceFiles
cylindrical.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

15
src/meshTools/coordinateSystems/coordinateSystem.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -43,17 +43,16 @@ Description
\endverbatim \endverbatim
Types of coordinateRotation: Types of coordinateRotation:
1) axesRotation
2) STARCDRotation \li 1. axesRotation
3) cylindrical \li 2. STARCDRotation
4) EulerCoordinateRotation \li 3. cylindrical
\li 4. EulerCoordinateRotation
Type of co-ordinates: Type of co-ordinates:
1) cartesian
\li 1. cartesian
See Also
coordinateSystem and coordinateSystem::New
SourceFiles SourceFiles
coordinateSystem.C coordinateSystem.C

5
src/meshTools/mappedPatches/mappedPolyPatch/mappedPatchBase.H
View File

@ -29,6 +29,7 @@ Description
centres and processors they're on. centres and processors they're on.
If constructed from dictionary: If constructed from dictionary:
\verbatim
// Region to sample (default is region0) // Region to sample (default is region0)
sampleRegion region0; sampleRegion region0;
@ -63,8 +64,9 @@ Description
// According to offsetMode (see above) supply one of // According to offsetMode (see above) supply one of
// offset, offsets or distance // offset, offsets or distance
offset (1 0 0); offset (1 0 0);
\endverbatim
Note: if offsetMode is 'normal' it uses outwards pointing normals. So Note: if offsetMode is \c normal it uses outwards pointing normals. So
supply a negative distance if sampling inside the domain. supply a negative distance if sampling inside the domain.
@ -218,6 +220,7 @@ protected:
// Derived information // Derived information
//- Communication schedule: //- Communication schedule:
//
// - Cells/faces to sample per processor // - Cells/faces to sample per processor
// - Patch faces to receive per processor // - Patch faces to receive per processor
// - schedule // - schedule

13
src/meshTools/triSurface/surfaceLocation/surfaceLocation.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 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -26,16 +26,21 @@ Class
Description Description
Contains information about location on a triSurface: Contains information about location on a triSurface:
- pointIndexHit:
\li pointIndexHit:
- location - location
- bool: hit/miss - bool: hit/miss
- index (of triangle/point/edge) - index (of triangle/point/edge)
- elementType():
\li elementType():
- what index above relates to. In triangle::proxType - what index above relates to. In triangle::proxType
- triangle():
\li triangle():
- last known triangle - last known triangle
SourceFiles SourceFiles
surfaceLocation.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

15
src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H
View File

@ -31,12 +31,13 @@ Description
This function object allows specification of different writing frequency This function object allows specification of different writing frequency
of objects registered to the database. It has similar functionality of objects registered to the database. It has similar functionality
as the main time database through the outputControl setting: as the main time database through the outputControl setting:
timeStep
outputTime \li \c timeStep
adjustableTime \li \c outputTime
runTime \li \c adjustableTime
clockTime \li \c runTime
cpuTime \li \c clockTime
\li \c cpuTime
Example of function object specification: Example of function object specification:
\verbatim \verbatim
@ -58,7 +59,7 @@ Description
exclusiveWriting | Takes over object writing | no | yes exclusiveWriting | Takes over object writing | no | yes
\endtable \endtable
exclusiveWriting disables automatic writing (i.e through database) of the \c exclusiveWriting disables automatic writing (i.e through database) of the
objects to avoid duplicate writing. objects to avoid duplicate writing.
SeeAlso SeeAlso

4
src/postProcessing/functionObjects/utilities/turbulenceFields/turbulenceFields.H
View File

@ -32,9 +32,11 @@ Description
further manipulation. further manipulation.
Fields are stored as copies of the original, with the prefix Fields are stored as copies of the original, with the prefix
"tubulenceModel:", e.g. "tubulenceModel:", e.g.:
\verbatim
turbulenceModel:R turbulenceModel:R
\endverbatim
Example of function object specification: Example of function object specification:
\verbatim \verbatim

33
src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisRadiativeCoupledMixed/filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.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-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,15 +22,14 @@ 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::compressible:: Foam::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField
filmPyrolysisRadiativeCoupledMixedFvPatchScalarField
Description Description
Mixed boundary condition for temperature, to be used in the flow and Mixed boundary condition for temperature, to be used in the flow and
pyrolysis regions when a film region model is used. pyrolysis regions when a film region model is used.
Example usage: Example usage:
\verbatim
myInterfacePatchName myInterfacePatchName
{ {
type filmPyrolysisRadiativeCoupledMixed; type filmPyrolysisRadiativeCoupledMixed;
@ -42,32 +41,38 @@ Description
filmDeltaWet 3e-4; filmDeltaWet 3e-4;
value $internalField; value $internalField;
} }
\endverbatim
Needs to be on underlying mapped(Wall)FvPatch. Needs to be on underlying mapped(Wall)FvPatch.
It calculates local field as It calculates local field as:
ratio = (filmDelta - filmDeltaDry)/(filmDeltaWet - filmDeltaDry),
when ratio = 1 is considered wet and the film temperarture is fixed at \verbatim
ratio = (filmDelta - filmDeltaDry)/(filmDeltaWet - filmDeltaDry)
\endverbatim
when ratio = 1 is considered wet and the film temperature is fixed at
the wall. If ratio = 0 (dry) it emulates the normal radiative solid BC. the wall. If ratio = 0 (dry) it emulates the normal radiative solid BC.
In between ratio 0 and 1 the gradient and value contributions are In between ratio 0 and 1 the gradient and value contributions are
weighted using the ratio field in the followig way: weighted using the ratio field in the following way:
\verbatim
qConv = ratio*htcwfilm*(Tfilm - *this); qConv = ratio*htcwfilm*(Tfilm - *this);
qRad = (1.0 - ratio)*Qr; qRad = (1.0 - ratio)*Qr;
\endverbatim
Then the solid can gain or loose energy through radiation or conduction Then the solid can gain or loose energy through radiation or conduction
towards the film. towards the film.
Note: kappa : heat conduction at patch. Notes:
Gets supplied how to lookup/calculate kappa:
- 'lookup' : lookup volScalarField (or volSymmTensorField) with name
- 'basicThermo' : use basicThermo and compressible::RASmodel to calculate K
- 'solidThermo' : use basicSolidThermo K()
Qr is the radiative flux defined in the radiation model. \li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
\li \c Qr is the radiative flux defined in the radiation model.
SeeAlso
Foam::temperatureCoupledBase
SourceFiles SourceFiles
filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C

2
src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.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-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License

2
src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.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-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License

4
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/patchInjection/patchInjection.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 OpenFOAM Foundation \\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ 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::patchInjection Foam::regionModels::surfaceFilmModels::patchInjection
Description Description
Remove and inject the mass in the film as it passes over the selected Remove and inject the mass in the film as it passes over the selected

18
src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.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-2014 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ 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::thermalBaffleFvPatchScalarField Foam::compressible::thermalBaffleFvPatchScalarField
Group Group
grpThermoBoundaryConditions grpThermoBoundaryConditions
@ -30,16 +30,18 @@ Group
Description Description
This boundary condition provides a coupled temperature condition between This boundary condition provides a coupled temperature condition between
multiple mesh regions. The regions are generally referred to as the: multiple mesh regions. The regions are generally referred to as the:
- primary region, and
- baffle region \li primary region,
\li and baffle region.
The primary region creates the baffle region and evolves its energy The primary region creates the baffle region and evolves its energy
equation either: equation either:
- 1-D, normal to each patch face - 1-D, normal to each patch face
- 2-D, normal and tangential components - 2-D, normal and tangential components
The thermodynamic properties of the baffle material are specified via The thermodynamic properties of the baffle material are specified via
dictionary entries on the master patch dictionary entries on the master patch.
\heading Patch usage \heading Patch usage
Example of the boundary condition specification: Example of the boundary condition specification:
@ -116,7 +118,7 @@ Description
} }
\endverbatim \endverbatim
/- Slave patch on primary region \li Slave patch on primary region
\verbatim \verbatim
myPatch_slave myPatch_slave
{ {
@ -127,7 +129,7 @@ Description
\endverbatim \endverbatim
/- Patches on baffle region \li Patches on baffle region
\verbatim \verbatim
bottom bottom
{ {
@ -148,7 +150,7 @@ Description
SeeAlso SeeAlso
Foam::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField Foam::compressible::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField
Foam::regionModels::thermalBaffleModels::thermalBaffleModel Foam::regionModels::thermalBaffleModels::thermalBaffleModel
SourceFiles SourceFiles

25
src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.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-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -35,30 +35,25 @@ Description
The essential entry "limit" controls the gradient of alpha1 on the wall: The essential entry "limit" controls the gradient of alpha1 on the wall:
limit none; // Calculate the gradient from the contact-angle without \li \c none - Calculate the gradient from the contact-angle without limiter
// limiter \li \c gradient - Limit the wall-gradient such that alpha1 remains bounded
on the wall
limit gradient; // Limit the wall-gradient such that alpha1 remains \li \c alpha - Bound the calculated alpha1 on the wall
// bounded on the wall \li \c zeroGradient - Set the gradient of alpha1 to 0 on the wall, i.e.
reproduce previous behaviour, the pressure BCs can be left as before.
limit alpha; // Bound the calculated alpha1 on the wall
limit zeroGradient; // Set the gradient of alpha1 to 0 on the wall
// i.e. reproduce previous behaviour
Note that if any of the first three options are used the boundary condition Note that if any of the first three options are used the boundary condition
on p_rgh must set to guarantee that the flux is corrected to be zero at the on \c p_rgh must set to guarantee that the flux is corrected to be zero at
wall e.g. the wall e.g.:
\verbatim \verbatim
myPatch myPatch
{ {
type alphaContactAngle; type alphaContactAngle;
limit none;
} }
\endverbatim \endverbatim
If "limit zeroGradient;" is used the pressure BCs can be left as before.
SourceFiles SourceFiles
alphaContactAngleFvPatchScalarField.C alphaContactAngleFvPatchScalarField.C