Corrected and improved documentation

Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=790
This commit is contained in:
Henry
2015-01-01 18:12:28 +00:00
parent dfeb45d191
commit 60349e311c
2 changed files with 20 additions and 14 deletions

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-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -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
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

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-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -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
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
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