Skip to content
Snippets Groups Projects
Commit 60349e31 authored by Henry's avatar Henry
Browse files

Corrected and improved documentation

parent dfeb45d1
No related branches found
No related tags found
No related merge requests found
...@@ -2,7 +2,7 @@ ...@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -35,8 +35,8 @@ Description ...@@ -35,8 +35,8 @@ Description
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | Flux field name | no | phi
inletValue | inlet value for reverse flow | yes | inletValue | Inlet value for reverse flow | yes |
\endtable \endtable
Example of the boundary condition specification: Example of the boundary condition specification:
...@@ -55,12 +55,13 @@ Description ...@@ -55,12 +55,13 @@ Description
Note Note
Sign conventions: Sign conventions:
- positive flux (out of domain): apply zero-gradient condition - Positive flux (out of domain): apply zero-gradient condition
- negative flux (into of domain): apply the user-specified fixed value - Negative flux (into of domain): apply the "inletValue" fixed-value
SeeAlso SeeAlso
Foam::mixedFvPatchField Foam::mixedFvPatchField
Foam::zeroGradientFvPatchField Foam::zeroGradientFvPatchField
Foam::outletInletFvPatchField
SourceFiles SourceFiles
inletOutletFvPatchField.C inletOutletFvPatchField.C
......
...@@ -2,7 +2,7 @@ ...@@ -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-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
...@@ -29,14 +29,14 @@ Group ...@@ -29,14 +29,14 @@ Group
Description Description
This boundary condition provides a generic inflow condition, with This boundary condition provides a generic inflow condition, with
specified outflow for the case of return flow. specified outflow for the case of reverse flow.
\heading Patch usage \heading Patch usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | Flux field name | no | phi
inletValue | inlet value | yes | outletValue | Outlet value for reverse flow | yes |
\endtable \endtable
Example of the boundary condition specification: Example of the boundary condition specification:
...@@ -44,9 +44,9 @@ Description ...@@ -44,9 +44,9 @@ Description
myPatch myPatch
{ {
type outletInlet; type outletInlet;
phi phi; // name of flux field (default = phi) phi phi;
outletValue uniform 0; // reverse flow (inlet) value outletValue uniform 0;
value uniform 0; // initial value value uniform 0;
} }
\endverbatim \endverbatim
...@@ -55,8 +55,13 @@ Description ...@@ -55,8 +55,13 @@ Description
Note Note
Sign conventions: Sign conventions:
- positive flux (out of domain): apply the user-specified fixed value - Positive flux (out of domain): apply the "outletValue" fixed-value
- negative flux (into of domain): apply zero-gradient condition - Negative flux (into of domain): apply zero-gradient condition
SeeAlso
Foam::mixedFvPatchField
Foam::zeroGradientFvPatchField
Foam::inletOutletFvPatchField
SourceFiles SourceFiles
outletInletFvPatchField.C outletInletFvPatchField.C
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment