189 lines
5.1 KiB
C++
189 lines
5.1 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
Foam::outletInletFvPatchField
|
|
|
|
Group
|
|
grpInletBoundaryConditions
|
|
|
|
Description
|
|
This boundary condition provides a generic inflow condition, with
|
|
specified outflow for the case of reverse flow.
|
|
|
|
Usage
|
|
\table
|
|
Property | Description | Required | Default value
|
|
phi | Flux field name | no | phi
|
|
outletValue | Outlet value for reverse flow | yes |
|
|
\endtable
|
|
|
|
Example of the boundary condition specification:
|
|
\verbatim
|
|
<patchName>
|
|
{
|
|
type outletInlet;
|
|
phi phi;
|
|
outletValue uniform 0;
|
|
value uniform 0;
|
|
}
|
|
\endverbatim
|
|
|
|
The mode of operation is determined by the sign of the flux across the
|
|
patch faces.
|
|
|
|
Note
|
|
Sign conventions:
|
|
- Positive flux (out of domain): apply the "outletValue" fixed-value
|
|
- Negative flux (into of domain): apply zero-gradient condition
|
|
|
|
See also
|
|
Foam::mixedFvPatchField
|
|
Foam::zeroGradientFvPatchField
|
|
Foam::inletOutletFvPatchField
|
|
|
|
SourceFiles
|
|
outletInletFvPatchField.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef outletInletFvPatchField_H
|
|
#define outletInletFvPatchField_H
|
|
|
|
#include "mixedFvPatchField.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class outletInletFvPatch Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Type>
|
|
class outletInletFvPatchField
|
|
:
|
|
public mixedFvPatchField<Type>
|
|
{
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Name of flux field
|
|
word phiName_;
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("outletInlet");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from patch and internal field
|
|
outletInletFvPatchField
|
|
(
|
|
const fvPatch&,
|
|
const DimensionedField<Type, volMesh>&
|
|
);
|
|
|
|
//- Construct from patch, internal field and dictionary
|
|
outletInletFvPatchField
|
|
(
|
|
const fvPatch&,
|
|
const DimensionedField<Type, volMesh>&,
|
|
const dictionary&
|
|
);
|
|
|
|
//- Construct by mapping given outletInletFvPatchField onto a new patch
|
|
outletInletFvPatchField
|
|
(
|
|
const outletInletFvPatchField<Type>&,
|
|
const fvPatch&,
|
|
const DimensionedField<Type, volMesh>&,
|
|
const fvPatchFieldMapper&
|
|
);
|
|
|
|
//- Construct as copy
|
|
outletInletFvPatchField
|
|
(
|
|
const outletInletFvPatchField<Type>&
|
|
);
|
|
|
|
//- Construct and return a clone
|
|
virtual tmp<fvPatchField<Type>> clone() const
|
|
{
|
|
return tmp<fvPatchField<Type>>
|
|
(
|
|
new outletInletFvPatchField<Type>(*this)
|
|
);
|
|
}
|
|
|
|
//- Construct as copy setting internal field reference
|
|
outletInletFvPatchField
|
|
(
|
|
const outletInletFvPatchField<Type>&,
|
|
const DimensionedField<Type, volMesh>&
|
|
);
|
|
|
|
//- Construct and return a clone setting internal field reference
|
|
virtual tmp<fvPatchField<Type>> clone
|
|
(
|
|
const DimensionedField<Type, volMesh>& iF
|
|
) const
|
|
{
|
|
return tmp<fvPatchField<Type>>
|
|
(
|
|
new outletInletFvPatchField<Type>(*this, iF)
|
|
);
|
|
}
|
|
|
|
|
|
// Member functions
|
|
|
|
//- Update the coefficients associated with the patch field
|
|
virtual void updateCoeffs();
|
|
|
|
//- Write
|
|
virtual void write(Ostream&) const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "outletInletFvPatchField.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|