coupledFreestreamFvPatchField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011-2013 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::coupledFreestreamFvPatchField
 
Group
    grpInletBoundaryConditions grpOutletBoundaryConditions
 
Description
    This boundary condition provides a free-stream condition.  It is a 'mixed'
    condition derived from the \c inletOutlet condition, whereby the mode of
    operation switches between fixed (free stream) value and zero gradient
    based on the sign of the flux.
 
    \heading Patch usage
 
    \table
        Property     | Description             | Required    | Default value
        freestreamValue   | freestream velocity          | yes         |
        phi          | flux field name         | no          | phi
    \endtable
 
    Example of the boundary condition specification:
    \verbatim
    myPatch
    {
        type            freestream;
        phi             phi;
    }
    \endverbatim
 
SeeAlso
    Foam::mixedFvPatchField
    Foam::freestreamFvPatchField
 
SourceFiles
    coupledFreestreamFvPatchField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef coupledFreestreamFvPatchField_H
#define coupledFreestreamFvPatchField_H
 
#include "freestreamFvPatchField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                   Class coupledFreestreamFvPatchField Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class coupledFreestreamFvPatchField
:
    public freestreamFvPatchField<Type>
{
    private:
        label debug_ =1; //控制调试信息的输出的
 
public:
 
    //- Runtime type information
    TypeName("coupledFreestream");
 
 
    // Constructors
 
        //- Construct from patch and internal field
        coupledFreestreamFvPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, volMesh>&
        );
 
        //- Construct from patch, internal field and dictionary
        coupledFreestreamFvPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, volMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given coupledFreestreamFvPatchField onto a new patch
        coupledFreestreamFvPatchField
        (
            const coupledFreestreamFvPatchField<Type>&,
            const fvPatch&,
            const DimensionedField<Type, volMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Construct as copy
        coupledFreestreamFvPatchField
        (
            const coupledFreestreamFvPatchField<Type>&
        );
 
        //- Construct and return a clone
        virtual tmp<fvPatchField<Type> > clone() const
        {
            return tmp<fvPatchField<Type> >
            (
                new coupledFreestreamFvPatchField<Type>(*this)
            );
        }
 
        //- Construct as copy setting internal field reference
        coupledFreestreamFvPatchField
        (
            const coupledFreestreamFvPatchField<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 coupledFreestreamFvPatchField<Type>(*this, iF)
            );
        }
 
 
    // Member functions
         //- Update the coefficients associated with the patch field
          virtual void updateCoeffs();
 
        // Return defining fields
 
            const Field<Type>& freestreamValue() const
            {
                return this->refValue();
            }
 
            Field<Type>& freestreamValue()
            {
                return this->refValue();
            }
 
 
        //- Write
        virtual void write(Ostream&) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "coupledFreestreamFvPatchField.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //