mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
Updated Doxygen documentation and files
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
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -33,7 +33,7 @@ Description
|
||||
This boundary condition provides a fixed density inlet condition for
|
||||
compressible solvers, where the density of calculated using:
|
||||
|
||||
\f{
|
||||
\f[
|
||||
\rho = \psi p
|
||||
\f]
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ Usage
|
||||
\param -ascii \n
|
||||
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")
|
||||
|
||||
\param -noZero \n
|
||||
|
||||
@ -2,15 +2,19 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<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® Programmer's C++ documentation </title>
|
||||
<!-- links -->
|
||||
<link href="../OpenFOAMdocIcon.png" rel="icon" type="image/png" />
|
||||
<link href="search/search.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="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</script>
|
||||
|
||||
<!-- meta info -->
|
||||
<meta
|
||||
|
||||
@ -11,6 +11,11 @@ body {
|
||||
font-size: 62.5%;
|
||||
} /*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 {
|
||||
content:".";
|
||||
display:block;
|
||||
@ -243,7 +248,7 @@ p:after {
|
||||
padding-bottom:30px;
|
||||
border-left: 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 {
|
||||
clear:both;
|
||||
|
||||
@ -25,7 +25,7 @@ Class
|
||||
Foam::Pstream
|
||||
|
||||
Description
|
||||
Inter-processor communications stream
|
||||
Inter-processor communications stream.
|
||||
|
||||
SourceFiles
|
||||
Pstream.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -21,6 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
InNamespace
|
||||
Foam
|
||||
|
||||
Description
|
||||
Inter-processor communication reduction functions.
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef PstreamReduceOps_H
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -110,12 +110,15 @@ public:
|
||||
|
||||
//- Construct from Time, a dictionary with "functions" entry
|
||||
// and the execution setting.
|
||||
// \param[in] t - the other Time instance to construct from
|
||||
// \param[in] parentDict - the parent dictionary containing
|
||||
// a "functions" entry, which can either be a list or a dictionary
|
||||
// of functionObject specifications.
|
||||
// \param[in] execution - whether the function objects should execute
|
||||
// or not. Default: true.
|
||||
functionObjectList
|
||||
(
|
||||
const Time&,
|
||||
const Time& t,
|
||||
const dictionary& parentDict,
|
||||
const bool execution=true
|
||||
);
|
||||
|
||||
@ -543,8 +543,6 @@ Type average(const FieldField<Field, Type>& f)
|
||||
TMP_UNARY_FUNCTION(Type, average)
|
||||
|
||||
|
||||
#include "PstreamReduceOps.H"
|
||||
|
||||
#define G_UNARY_FUNCTION(returnType, gFunc, func, rFunc) \
|
||||
\
|
||||
template<template<class> class Field, class Type> \
|
||||
|
||||
@ -57,7 +57,7 @@ Description
|
||||
}
|
||||
\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
|
||||
which would have a corresponding entry
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -41,7 +41,9 @@ namespace Foam
|
||||
namespace debug
|
||||
{
|
||||
|
||||
//! \cond ignoreDocumentation - local scope
|
||||
//! \cond ignoreDocumentation
|
||||
//- Skip documentation : local scope only
|
||||
|
||||
dictionary* controlDictPtr_(NULL);
|
||||
dictionary* debugSwitchesPtr_(NULL);
|
||||
dictionary* infoSwitchesPtr_(NULL);
|
||||
@ -55,7 +57,7 @@ simpleObjectRegistry* dimensionSetObjectsPtr_(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
|
||||
{
|
||||
public:
|
||||
|
||||
@ -4,6 +4,8 @@
|
||||
#include "scalar.H"
|
||||
#include "vector.H"
|
||||
#include "curve.H"
|
||||
#include "char.H"
|
||||
#include "List.H"
|
||||
|
||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||
|
||||
@ -13,9 +15,6 @@ namespace Foam
|
||||
#define curveSmall 1.0e-8
|
||||
#define curveGreat 1.0e8
|
||||
|
||||
#include "char.H"
|
||||
#include "List.H"
|
||||
|
||||
typedef List<char> charList;
|
||||
typedef List<charList> charListList;
|
||||
|
||||
|
||||
@ -29,9 +29,9 @@ Description
|
||||
The reference scalar values must be monotonically increasing.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -40,11 +40,13 @@ Description
|
||||
other format is csv (comma separated values):
|
||||
|
||||
Read csv format:
|
||||
\verbatim
|
||||
readerType csv;
|
||||
fileName "$FOAM_CASE/constant/p0vsTime.csv";
|
||||
hasHeaderLine true; // skip first line
|
||||
timeColumn 0; // time is in column 0
|
||||
valueColumns (1); // value starts in column 1
|
||||
\endverbatim
|
||||
|
||||
|
||||
Note
|
||||
|
||||
@ -171,10 +171,11 @@ protected:
|
||||
|
||||
// Processor agglomeration
|
||||
|
||||
//- Collect and combine processor meshes into allMesh.
|
||||
//- Collect and combine processor meshes into allMesh:
|
||||
//
|
||||
// - allMeshComm : communicator for combined mesh.
|
||||
// - procAgglomMap : per processor the new agglomerated processor
|
||||
// (rank in allMeshComm!). Global information.
|
||||
// - procAgglomMap : per processor the new agglomerated
|
||||
// processor (rank in allMeshComm!). Global information.
|
||||
// - procIDs : local information: same for all in
|
||||
// agglomerated processor.
|
||||
void procAgglomerateLduAddressing
|
||||
@ -187,8 +188,9 @@ protected:
|
||||
);
|
||||
|
||||
//- Collect and combine basic restriction addressing:
|
||||
// nCells_
|
||||
// restrictAddressing_
|
||||
//
|
||||
// - nCells_
|
||||
// - restrictAddressing_
|
||||
void procAgglomerateRestrictAddressing
|
||||
(
|
||||
const label comm,
|
||||
@ -426,6 +428,7 @@ public:
|
||||
// with GAMGSolver notation.
|
||||
|
||||
//- Given fine to coarse processor map determine:
|
||||
//
|
||||
// - for each coarse processor a master (minimum of the fine
|
||||
// processors)
|
||||
// - for each coarse processor the set of fine processors
|
||||
|
||||
@ -33,6 +33,7 @@ Description
|
||||
MoveableMeshObject, UpdateableMeshObject) and the type of the actual object
|
||||
it is created for example:
|
||||
|
||||
\verbatim
|
||||
class leastSquaresVectors
|
||||
:
|
||||
public MeshObject<fvMesh, MoveableMeshObject, leastSquaresVectors>
|
||||
@ -43,17 +44,20 @@ Description
|
||||
//- Delete the least square vectors when the mesh moves
|
||||
virtual bool movePoints();
|
||||
};
|
||||
\endverbatim
|
||||
|
||||
MeshObject types:
|
||||
|
||||
TopologicalMeshObject: mesh object to be deleted on topology change
|
||||
GeometricMeshObject: mesh object to be deleted on geometry change
|
||||
MoveableMeshObject: mesh object to be updated in movePoints
|
||||
UpdateableMeshObject: mesh object to be updated in updateMesh or movePoints
|
||||
- TopologicalMeshObject: mesh object to be deleted on topology change
|
||||
- GeometricMeshObject: mesh object to be deleted on geometry change
|
||||
- MoveableMeshObject: mesh object to be updated in movePoints
|
||||
- UpdateableMeshObject: mesh object to be updated in updateMesh or
|
||||
movePoints
|
||||
|
||||
Note that movePoints must be provided for MeshObjects of type
|
||||
MoveableMeshObject and both movePoints and updateMesh functions must exist
|
||||
provided for MeshObjects of type UpdateableMeshObject.
|
||||
Note
|
||||
movePoints must be provided for MeshObjects of type MoveableMeshObject
|
||||
and both movePoints and updateMesh functions must exist, provided for
|
||||
MeshObjects of type UpdateableMeshObject.
|
||||
|
||||
SourceFiles
|
||||
MeshObject.C
|
||||
|
||||
@ -123,6 +123,7 @@ public:
|
||||
|
||||
//- Determine the mapping for a sub-patch.
|
||||
// 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[out] pointMap mapping new to old localPoints
|
||||
// \param[out] faceMap mapping new to old faces
|
||||
@ -136,7 +137,7 @@ public:
|
||||
>
|
||||
static void subsetMap
|
||||
(
|
||||
const PrimitivePatch<Face, FaceList, PointField, PointType>&,
|
||||
const PrimitivePatch<Face, FaceList, PointField, PointType>& p,
|
||||
const BoolListType& includeFaces,
|
||||
labelList& pointMap,
|
||||
labelList& faceMap
|
||||
|
||||
@ -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] =
|
||||
{
|
||||
{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] =
|
||||
{
|
||||
{0, 1}, // 0
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -62,7 +62,7 @@ Description
|
||||
type compressible::turbulentTemperatureCoupledBaffleMixed;
|
||||
Tnbr T;
|
||||
kappa lookup;
|
||||
KappaName kappa;
|
||||
kappaName kappa;
|
||||
thicknessLayers (0.1 0.2 0.3 0.4);
|
||||
kappaLayers (1 2 3 4)
|
||||
value uniform 300;
|
||||
@ -71,14 +71,13 @@ Description
|
||||
|
||||
Needs to be on underlying mapped(Wall)FvPatch.
|
||||
|
||||
Note: kappa : heat conduction at patch. Gets supplied how to lookup
|
||||
calculate kappa:
|
||||
Note:
|
||||
|
||||
- 'lookup' : lookup volScalarField (or volSymmTensorField) with name
|
||||
- 'fluidThermo' : use fluidThermo and compressible::RASmodel to calculate
|
||||
kappa
|
||||
- 'solidThermo' : use solidThermo kappa()
|
||||
- 'directionalSolidThermo' directionalKappa()
|
||||
\li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
|
||||
|
||||
|
||||
SeeAlso
|
||||
Foam::temperatureCoupledBase
|
||||
|
||||
SourceFiles
|
||||
turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.C
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -29,7 +29,7 @@ License
|
||||
This group contains RAS turbulence model boundary conditions
|
||||
@}
|
||||
|
||||
\defgroup grpWallFunctions RAS wall functions
|
||||
\defgroup grpRASWallFunctions RAS wall functions
|
||||
@{
|
||||
\ingroup grpRASBoundaryConditions
|
||||
This group contains RAS turbulence model wall functions
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -28,6 +28,8 @@ Description
|
||||
Mesh at a patch created on the fly. The following entry should be used
|
||||
on the field boundary dictionary:
|
||||
|
||||
Example:
|
||||
\verbatim
|
||||
// New Shell mesh data
|
||||
|
||||
extrudeModel linearNormal;
|
||||
@ -61,6 +63,7 @@ Description
|
||||
name "side";
|
||||
type empty;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -25,13 +25,14 @@ Class
|
||||
Foam::fv::option
|
||||
|
||||
Description
|
||||
Finite volume options abtract base class. Provides a base set of controls,
|
||||
e.g.
|
||||
|
||||
Finite volume options abstract base class. Provides a base set of
|
||||
controls, e.g.:
|
||||
\verbatim
|
||||
type scalarExplicitSource // source type
|
||||
active on; // on/off switch
|
||||
\endverbatim
|
||||
|
||||
Note:
|
||||
Note
|
||||
On evaluation, source/sink options are to be added to the equation R.H.S.
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -54,7 +54,7 @@ Description
|
||||
U | velocity
|
||||
\endvartable
|
||||
|
||||
3. compressible transonic (\gamma <= 1):
|
||||
3. compressible transonic (\f$\gamma <= 1\f$):
|
||||
\f[
|
||||
p_p = \frac{p_0}{1 + 0.5 \psi |U|^2}
|
||||
\f]
|
||||
@ -65,7 +65,7 @@ Description
|
||||
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
|
||||
\endvartable
|
||||
|
||||
4. compressible supersonic (\gamma > 1):
|
||||
4. compressible supersonic (\f$\gamma > 1\f$):
|
||||
\f[
|
||||
p_p = \frac{p_0}{(1 + 0.5 \psi G |U|^2)^{\frac{1}{G}}}
|
||||
\f]
|
||||
|
||||
@ -27,8 +27,12 @@ Class
|
||||
Description
|
||||
Interpolates pre-specified motion.
|
||||
|
||||
Motion specified as pointVectorFields. E.g.
|
||||
Motion specified as pointVectorFields.
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
Example:
|
||||
\verbatim
|
||||
walls
|
||||
{
|
||||
type uniformInterpolatedDisplacement;
|
||||
@ -36,9 +40,10 @@ Description
|
||||
fieldName wantedDisplacement;
|
||||
interpolationScheme linear;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
This will scan the case for 'wantedDisplacement' pointVectorFields
|
||||
and interpolate those in time (using 'linear' interpolation) to
|
||||
This will scan the case for \a wantedDisplacement pointVectorFields
|
||||
and interpolate those in time (using \c linear interpolation) to
|
||||
obtain the current displacement.
|
||||
The advantage of specifying displacement in this way is that it
|
||||
automatically works through decomposePar.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -26,8 +26,8 @@ Class
|
||||
|
||||
Description
|
||||
Cell-set options abtract base class. Provides a base set of controls,
|
||||
e.g.
|
||||
|
||||
e.g.:
|
||||
\verbatim
|
||||
type scalarExplicitSource // Source type
|
||||
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.
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -25,10 +25,11 @@ Class
|
||||
Foam::fv::interRegionExplicitPorositySource
|
||||
|
||||
Description
|
||||
Inter-region explicit porosity source
|
||||
Inter-region explicit porosity source.
|
||||
|
||||
Sources described by, for example using the DarcyForchheimer model:
|
||||
|
||||
\verbatim
|
||||
interRegionExplicitPorositySourceCoeffs
|
||||
{
|
||||
type DarcyForchheimer;
|
||||
@ -44,8 +45,9 @@ Description
|
||||
}
|
||||
}
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note:
|
||||
Note
|
||||
The porous region must be selected as a cellZone.
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -25,16 +25,17 @@ Class
|
||||
Foam::ParticleTrap
|
||||
|
||||
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:
|
||||
|
||||
\verbatim
|
||||
particleTrap1
|
||||
{
|
||||
type particleTrap;
|
||||
alphaName alpha; // name volume fraction field
|
||||
threshold 0.95; // alpha value below which model is active
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -25,14 +25,17 @@ Class
|
||||
Foam::CellZoneInjection
|
||||
|
||||
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)
|
||||
- Total mass to inject
|
||||
- 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
|
||||
CellZoneInjection.C
|
||||
|
||||
@ -25,14 +25,16 @@ Class
|
||||
Foam::ConeInjection
|
||||
|
||||
Description
|
||||
Multi-point cone injection model
|
||||
- User specifies
|
||||
Multi-point cone injection model.
|
||||
|
||||
\li User specifies:
|
||||
- time of start of injection
|
||||
- list of injector positions and directions (along injection axes)
|
||||
- number of parcels to inject per injector
|
||||
- parcel velocities
|
||||
- inner and outer half-cone angles
|
||||
- Parcel diameters obtained by distribution model
|
||||
|
||||
\li Parcel diameters obtained by distribution model
|
||||
|
||||
SourceFiles
|
||||
ConeInjection.C
|
||||
|
||||
@ -25,25 +25,32 @@ Class
|
||||
Foam::ConeNozzleInjection
|
||||
|
||||
Description
|
||||
Cone injection
|
||||
Cone injection.
|
||||
|
||||
- User specifies
|
||||
\li User specifies:
|
||||
- time of start of injection
|
||||
- injector position
|
||||
- direction (along injection axis)
|
||||
- parcel flow rate
|
||||
- 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:
|
||||
|
||||
- Constant velocity
|
||||
\li Parcel velocity is calculated as:
|
||||
- Constant velocity:
|
||||
\verbatim
|
||||
U = \<specified by user\>
|
||||
- Pressure driven velocity
|
||||
\endverbatim
|
||||
|
||||
- Pressure driven velocity:
|
||||
\verbatim
|
||||
U = sqrt(2*(Pinj - Pamb)/rho)
|
||||
- Flow rate and discharge
|
||||
\endverbatim
|
||||
|
||||
- Flow rate and discharge:
|
||||
\verbatim
|
||||
U = V_dot/(A*Cd)
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
ConeNozzleInjection.C
|
||||
|
||||
@ -27,16 +27,16 @@ Class
|
||||
Description
|
||||
Injection at specified positions, with the conditions:
|
||||
|
||||
- for injection to be allowed
|
||||
|
||||
\li for injection to be allowed
|
||||
\verbatim
|
||||
factor*referenceField[cellI] >= thresholdField[cellI]
|
||||
|
||||
\endverbatim
|
||||
where:
|
||||
- referenceField is the field used to supply the look-up values
|
||||
- thresholdField supplies the values beyond which the injection is
|
||||
permitted
|
||||
- \c referenceField is the field used to supply the look-up values
|
||||
- \c thresholdField supplies the values beyond which the injection is
|
||||
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
|
||||
FieldActivatedInjection.C
|
||||
|
||||
@ -28,19 +28,23 @@ Description
|
||||
Particle injection sources read from look-up table. Each row corresponds to
|
||||
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 2
|
||||
...
|
||||
(x y z) (u v w) d rho mDot // injector N
|
||||
);
|
||||
\endverbatim
|
||||
|
||||
where:
|
||||
x, y, z = global cartesian co-ordinates [m]
|
||||
u, v, w = global cartesian velocity components [m/s]
|
||||
d = diameter [m]
|
||||
rho = density [kg/m3]
|
||||
mDot = mass flow rate [kg/m3]
|
||||
\plaintable
|
||||
x, y, z | global cartesian co-ordinates [m]
|
||||
u, v, w | global cartesian velocity components [m/s]
|
||||
d | diameter [m]
|
||||
rho | density [kg/m3]
|
||||
mDot | mass flow rate [kg/m3]
|
||||
\endplaintable
|
||||
|
||||
SourceFiles
|
||||
KinematicLookupTableInjection.C
|
||||
|
||||
@ -25,13 +25,16 @@ Class
|
||||
Foam::ManualInjection
|
||||
|
||||
Description
|
||||
Manual injection
|
||||
- User specifies
|
||||
Manual injection.
|
||||
|
||||
\li User specifies:
|
||||
- Total mass to inject
|
||||
- Parcel positions in file \c positionsFile
|
||||
- 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
|
||||
ManualInjection.C
|
||||
|
||||
@ -25,17 +25,17 @@ Class
|
||||
Foam::PatchFlowRateInjection
|
||||
|
||||
Description
|
||||
Patch injection
|
||||
- uses patch flow rate to determine concentration and velociy
|
||||
Patch injection, by using patch flow rate to determine concentration and
|
||||
velocity.
|
||||
|
||||
- User specifies
|
||||
\li User specifies
|
||||
- Total mass to inject
|
||||
- Name of patch
|
||||
- Injection duration
|
||||
- Injection target concentration/carrier volume flow rate
|
||||
- Initial parcel velocity given by local flow velocity
|
||||
- Parcel diameters obtained by distribution model
|
||||
- Parcels injected randomly across the patch
|
||||
\li Initial parcel velocity given by local flow velocity
|
||||
\li Parcel diameters obtained by distribution model
|
||||
\li Parcels injected randomly across the patch
|
||||
|
||||
SourceFiles
|
||||
PatchFlowRateInjection.C
|
||||
|
||||
@ -25,15 +25,16 @@ Class
|
||||
Foam::PatchInjection
|
||||
|
||||
Description
|
||||
Patch injection
|
||||
- User specifies
|
||||
Patch injection.
|
||||
|
||||
\li User specifies:
|
||||
- Total mass to inject
|
||||
- Name of patch
|
||||
- Injection duration
|
||||
- Initial parcel velocity
|
||||
- Injection volume flow rate
|
||||
- Parcel diameters obtained by distribution model
|
||||
- Parcels injected randomly across the patch
|
||||
\li Parcel diameters obtained by distribution model
|
||||
\li Parcels injected randomly across the patch
|
||||
|
||||
SourceFiles
|
||||
PatchInjection.C
|
||||
|
||||
@ -26,18 +26,20 @@ Class
|
||||
|
||||
Description
|
||||
Wall interaction model. Three choices:
|
||||
- rebound - optionally specify elasticity and resitution coefficients
|
||||
- stick - particles assigined zero velocity
|
||||
- escape - remove particle from the domain
|
||||
|
||||
\li \c rebound - optionally specify elasticity and restitution coefficients
|
||||
\li \c stick - particles assigned zero velocity
|
||||
\li \c escape - remove particle from the domain
|
||||
|
||||
Example usage:
|
||||
|
||||
\verbatim
|
||||
StandardWallInteractionCoeffs
|
||||
{
|
||||
type rebound; // stick, escape
|
||||
e 1; // optional - elasticity coeff
|
||||
mu 0; // optional - restitution coeff
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -140,11 +140,12 @@ public:
|
||||
//- Highest distance of all features
|
||||
scalar maxDistance() const;
|
||||
|
||||
//- Find nearest point on nearest feature edge. Sets
|
||||
//- Find nearest point on nearest feature edge. Sets:
|
||||
//
|
||||
// - nearFeature: index of feature mesh
|
||||
// - nearInfo : location on feature edge and edge index
|
||||
// (note: not feature edge index but index into
|
||||
// edges() directly)
|
||||
// (note: not feature edge index but index into edges()
|
||||
// directly)
|
||||
// - nearNormal : local feature edge normal
|
||||
void findNearestEdge
|
||||
(
|
||||
@ -155,11 +156,12 @@ public:
|
||||
vectorField& nearNormal
|
||||
) const;
|
||||
|
||||
//- Find nearest point on nearest region edge. Sets
|
||||
//- Find nearest point on nearest region edge. Sets:
|
||||
//
|
||||
// - nearFeature: index of feature mesh
|
||||
// - nearInfo : location on feature edge and edge index
|
||||
// (note: not feature edge index but index into
|
||||
// edges() directly)
|
||||
// (note: not feature edge index but index into edges()
|
||||
// directly)
|
||||
// - nearNormal : local feature edge normal
|
||||
void findNearestRegionEdge
|
||||
(
|
||||
@ -170,11 +172,12 @@ public:
|
||||
vectorField& nearNormal
|
||||
) const;
|
||||
|
||||
//- Find nearest feature point. Sets
|
||||
//- Find nearest feature point. Sets:
|
||||
//
|
||||
// - nearFeature: index of feature mesh
|
||||
// - nearInfo : location on feature point and point index.
|
||||
// (note: not index into shapes().pointLabels() but
|
||||
// index into points() directly)
|
||||
// (note: not index into shapes().pointLabels() but index
|
||||
// into points() directly)
|
||||
void findNearestPoint
|
||||
(
|
||||
const pointField& samples,
|
||||
|
||||
@ -60,6 +60,7 @@ public:
|
||||
// Public data types
|
||||
|
||||
//- Enumeration defining the layer specification:
|
||||
//
|
||||
// - first and total thickness specified
|
||||
// - first and expansion ratio specified
|
||||
// - final and total thickness specified
|
||||
@ -166,11 +167,12 @@ public:
|
||||
|
||||
// Per patch information
|
||||
|
||||
//- How many layers to add.
|
||||
// -1 : no specification. Assume 0 layers but allow sliding
|
||||
//- How many layers to add:
|
||||
//
|
||||
// - -1 : no specification. Assume 0 layers but allow sliding
|
||||
// to make layers
|
||||
// 0 : specified to have 0 layers. No sliding allowed.
|
||||
// >0 : number of layers
|
||||
// - 0 : specified to have 0 layers. No sliding allowed.
|
||||
// - >0 : number of layers
|
||||
const labelList& numLayers() const
|
||||
{
|
||||
return numLayers_;
|
||||
|
||||
@ -39,12 +39,15 @@ Description
|
||||
\verbatim
|
||||
coordinateRotation
|
||||
{
|
||||
type EulerRotation
|
||||
type EulerRotation;
|
||||
degrees false;
|
||||
rotation (0 0 3.141592654);
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
EulerCoordinateRotation.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef EulerCoordinateRotation_H
|
||||
|
||||
@ -42,6 +42,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
STARCDCoordinateRotation.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef STARCDCoordinateRotation_H
|
||||
|
||||
@ -28,7 +28,8 @@ Description
|
||||
A coordinate rotation specified using global axis
|
||||
|
||||
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
|
||||
axesRotation
|
||||
@ -39,6 +40,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
axesRotation.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
#ifndef axesRotation_H
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -37,12 +37,15 @@ Description
|
||||
\endverbatim
|
||||
|
||||
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
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -28,11 +28,10 @@ Description
|
||||
A local coordinate rotation.
|
||||
The cell based rotational field can be created in two ways:
|
||||
|
||||
1) Each rotational tensor is defined with two vectors (dir and e3)
|
||||
where dir = cellC - origin and e3 is the rotation axis.
|
||||
\li 1. Each rotational tensor is defined with two vectors (\c dir and \c e3)
|
||||
where <tt>dir = cellC - origin</tt> and \c e3 is the rotation axis.
|
||||
Per each cell an axesRotation type of rotation is created
|
||||
(cylindrical coordinates)
|
||||
|
||||
(cylindrical coordinates). For example:
|
||||
\verbatim
|
||||
cylindrical
|
||||
{
|
||||
@ -41,7 +40,10 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
2) The rotational tensor field is provided at construction
|
||||
\li 2. The rotational tensor field is provided at construction.
|
||||
|
||||
SourceFiles
|
||||
cylindrical.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -43,17 +43,16 @@ Description
|
||||
\endverbatim
|
||||
|
||||
Types of coordinateRotation:
|
||||
1) axesRotation
|
||||
2) STARCDRotation
|
||||
3) cylindrical
|
||||
4) EulerCoordinateRotation
|
||||
|
||||
\li 1. axesRotation
|
||||
\li 2. STARCDRotation
|
||||
\li 3. cylindrical
|
||||
\li 4. EulerCoordinateRotation
|
||||
|
||||
Type of co-ordinates:
|
||||
1) cartesian
|
||||
|
||||
\li 1. cartesian
|
||||
|
||||
See Also
|
||||
coordinateSystem and coordinateSystem::New
|
||||
|
||||
SourceFiles
|
||||
coordinateSystem.C
|
||||
|
||||
@ -29,6 +29,7 @@ Description
|
||||
centres and processors they're on.
|
||||
|
||||
If constructed from dictionary:
|
||||
\verbatim
|
||||
// Region to sample (default is region0)
|
||||
sampleRegion region0;
|
||||
|
||||
@ -63,8 +64,9 @@ Description
|
||||
// According to offsetMode (see above) supply one of
|
||||
// offset, offsets or distance
|
||||
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.
|
||||
|
||||
|
||||
@ -218,6 +220,7 @@ protected:
|
||||
// Derived information
|
||||
|
||||
//- Communication schedule:
|
||||
//
|
||||
// - Cells/faces to sample per processor
|
||||
// - Patch faces to receive per processor
|
||||
// - schedule
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -26,16 +26,21 @@ Class
|
||||
|
||||
Description
|
||||
Contains information about location on a triSurface:
|
||||
- pointIndexHit:
|
||||
|
||||
\li pointIndexHit:
|
||||
- location
|
||||
- bool: hit/miss
|
||||
- index (of triangle/point/edge)
|
||||
- elementType():
|
||||
|
||||
\li elementType():
|
||||
- what index above relates to. In triangle::proxType
|
||||
- triangle():
|
||||
|
||||
\li triangle():
|
||||
- last known triangle
|
||||
|
||||
|
||||
SourceFiles
|
||||
surfaceLocation.C
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -31,12 +31,13 @@ Description
|
||||
This function object allows specification of different writing frequency
|
||||
of objects registered to the database. It has similar functionality
|
||||
as the main time database through the outputControl setting:
|
||||
timeStep
|
||||
outputTime
|
||||
adjustableTime
|
||||
runTime
|
||||
clockTime
|
||||
cpuTime
|
||||
|
||||
\li \c timeStep
|
||||
\li \c outputTime
|
||||
\li \c adjustableTime
|
||||
\li \c runTime
|
||||
\li \c clockTime
|
||||
\li \c cpuTime
|
||||
|
||||
Example of function object specification:
|
||||
\verbatim
|
||||
@ -58,7 +59,7 @@ Description
|
||||
exclusiveWriting | Takes over object writing | no | yes
|
||||
\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.
|
||||
|
||||
SeeAlso
|
||||
|
||||
@ -32,9 +32,11 @@ Description
|
||||
further manipulation.
|
||||
|
||||
Fields are stored as copies of the original, with the prefix
|
||||
"tubulenceModel:", e.g.
|
||||
"tubulenceModel:", e.g.:
|
||||
|
||||
\verbatim
|
||||
turbulenceModel:R
|
||||
\endverbatim
|
||||
|
||||
Example of function object specification:
|
||||
\verbatim
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -22,15 +22,14 @@ License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Class
|
||||
Foam::compressible::
|
||||
filmPyrolysisRadiativeCoupledMixedFvPatchScalarField
|
||||
Foam::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField
|
||||
|
||||
Description
|
||||
Mixed boundary condition for temperature, to be used in the flow and
|
||||
pyrolysis regions when a film region model is used.
|
||||
|
||||
|
||||
Example usage:
|
||||
\verbatim
|
||||
myInterfacePatchName
|
||||
{
|
||||
type filmPyrolysisRadiativeCoupledMixed;
|
||||
@ -42,32 +41,38 @@ Description
|
||||
filmDeltaWet 3e-4;
|
||||
value $internalField;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Needs to be on underlying mapped(Wall)FvPatch.
|
||||
It calculates local field as
|
||||
ratio = (filmDelta - filmDeltaDry)/(filmDeltaWet - filmDeltaDry),
|
||||
It calculates local field as:
|
||||
|
||||
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.
|
||||
|
||||
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);
|
||||
qRad = (1.0 - ratio)*Qr;
|
||||
\endverbatim
|
||||
|
||||
Then the solid can gain or loose energy through radiation or conduction
|
||||
towards the film.
|
||||
|
||||
Note: kappa : heat conduction at patch.
|
||||
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()
|
||||
Notes:
|
||||
|
||||
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
|
||||
filmPyrolysisRadiativeCoupledMixedFvPatchScalarField.C
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -22,7 +22,7 @@ License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Class
|
||||
Foam::patchInjection
|
||||
Foam::regionModels::surfaceFilmModels::patchInjection
|
||||
|
||||
Description
|
||||
Remove and inject the mass in the film as it passes over the selected
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -22,7 +22,7 @@ License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Class
|
||||
Foam::thermalBaffleFvPatchScalarField
|
||||
Foam::compressible::thermalBaffleFvPatchScalarField
|
||||
|
||||
Group
|
||||
grpThermoBoundaryConditions
|
||||
@ -30,16 +30,18 @@ Group
|
||||
Description
|
||||
This boundary condition provides a coupled temperature condition between
|
||||
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
|
||||
equation either:
|
||||
|
||||
- 1-D, normal to each patch face
|
||||
- 2-D, normal and tangential components
|
||||
|
||||
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
|
||||
Example of the boundary condition specification:
|
||||
@ -116,7 +118,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
/- Slave patch on primary region
|
||||
\li Slave patch on primary region
|
||||
\verbatim
|
||||
myPatch_slave
|
||||
{
|
||||
@ -127,7 +129,7 @@ Description
|
||||
\endverbatim
|
||||
|
||||
|
||||
/- Patches on baffle region
|
||||
\li Patches on baffle region
|
||||
\verbatim
|
||||
bottom
|
||||
{
|
||||
@ -148,7 +150,7 @@ Description
|
||||
|
||||
|
||||
SeeAlso
|
||||
Foam::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField
|
||||
Foam::compressible::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField
|
||||
Foam::regionModels::thermalBaffleModels::thermalBaffleModel
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
========= |
|
||||
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
\\ / O peration |
|
||||
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
|
||||
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
||||
\\/ M anipulation |
|
||||
-------------------------------------------------------------------------------
|
||||
License
|
||||
@ -35,30 +35,25 @@ Description
|
||||
|
||||
The essential entry "limit" controls the gradient of alpha1 on the wall:
|
||||
|
||||
limit none; // Calculate the gradient from the contact-angle without
|
||||
// limiter
|
||||
|
||||
limit gradient; // Limit the wall-gradient such that alpha1 remains
|
||||
// bounded on the wall
|
||||
|
||||
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
|
||||
\li \c none - Calculate the gradient from the contact-angle without limiter
|
||||
\li \c gradient - Limit the wall-gradient such that alpha1 remains bounded
|
||||
on the wall
|
||||
\li \c alpha - Bound the calculated alpha1 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.
|
||||
|
||||
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
|
||||
wall e.g.
|
||||
on \c p_rgh must set to guarantee that the flux is corrected to be zero at
|
||||
the wall e.g.:
|
||||
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type alphaContactAngle;
|
||||
limit none;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
If "limit zeroGradient;" is used the pressure BCs can be left as before.
|
||||
|
||||
SourceFiles
|
||||
alphaContactAngleFvPatchScalarField.C
|
||||
|
||||
|
||||
Reference in New Issue
Block a user