coupledFixedValueFvPatchField.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::coupledFixedValueFvPatchField
 
  Group
  grpGenericBoundaryConditions
 
  Description
  This boundary condition supplies a fixed value constraint, and is the base
  class for a number of other boundary conditions.
 
  \heading Patch usage
 
  \table
  Property     | Description             | Required    | Default value
  value        | Patch face values       | yes         |
  \endtable
 
  Example of the boundary condition specification:
  \verbatim
  myPatch
  {
  type            coupledFixedValue;
  value           uniform 0;  // example for scalar field usage
  }
  \endverbatim
 
  SourceFiles
  coupledFixedValueFvPatchField.C
 
  \*---------------------------------------------------------------------------*/
 
#ifndef coupledFixedValueFvPatchField_H
#define coupledFixedValueFvPatchField_H
 
#include "fvPatchField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
    /*---------------------------------------------------------------------------*\
      Class coupledFixedValueFvPatchField Declaration
      \*---------------------------------------------------------------------------*/
 
    template<class Type>
        class coupledFixedValueFvPatchField
        :
            public fvPatchField<Type>
    {
 
        //private data
        //
        const word neighbourName_;
        label debug_ = 1;//const word neighbourName_;
        public:
 
        //- Runtime type information
        TypeName("coupledFixedValue");
 
 
        // Constructors
 
        //- Construct from patch and internal field
        coupledFixedValueFvPatchField
            (
             const fvPatch&,
             const DimensionedField<Type, volMesh>&
            );
 
        //- Construct from patch, internal field and dictionary
        coupledFixedValueFvPatchField
            (
             const fvPatch&,
             const DimensionedField<Type, volMesh>&,
             const dictionary&
            );
 
        //- Construct by mapping the given coupledFixedValueFvPatchField<Type>
        //  onto a new patch
        coupledFixedValueFvPatchField
            (
             const coupledFixedValueFvPatchField<Type>&,
             const fvPatch&,
             const DimensionedField<Type, volMesh>&,
             const fvPatchFieldMapper&
            );
 
        //- Construct as copy
        coupledFixedValueFvPatchField
            (
             const coupledFixedValueFvPatchField<Type>&
            );
 
        //- Construct and return a clone
        virtual tmp<fvPatchField<Type> > clone() const
        {
            return tmp<fvPatchField<Type> >
                (
                 new coupledFixedValueFvPatchField<Type>(*this)
                );
        }
 
        //- Construct as copy setting internal field reference
        coupledFixedValueFvPatchField
            (
             const coupledFixedValueFvPatchField<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 coupledFixedValueFvPatchField<Type>(*this, iF)
                    );
            }
 
 
        // Member functions
 
        // Access
 
        //- Return true if this patch field fixes a value.
        //  Needed to check if a level has to be specified while solving
        //  Poissons equations.
        virtual bool fixesValue() const
        {
            return true;
        }
 
 
        // Evaluation functions
 
        //- Return the matrix diagonal coefficients corresponding to the
        //  evaluation of the value of this patchField with given weights
        virtual tmp<Field<Type> > valueInternalCoeffs
            (
             const tmp<scalarField>&
            ) const;
 
        //- Return the matrix source coefficients corresponding to the
        //  evaluation of the value of this patchField with given weights
        virtual tmp<Field<Type> > valueBoundaryCoeffs
            (
             const tmp<scalarField>&
            ) const;
 
        //- Return the matrix diagonal coefficients corresponding to the
        //  evaluation of the gradient of this patchField
        virtual tmp<Field<Type> > gradientInternalCoeffs() const;
 
        //- Return the matrix source coefficients corresponding to the
        //  evaluation of the gradient of this patchField
        virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
 
        //- Update the coefficients associated with the patch field
        virtual void updateCoeffs();
 
        //- Evaluate the patch field
        virtual void evaluate
            (
             const Pstream::commsTypes commsType=Pstream::blocking
            );
 
        //- Write
        virtual void write(Ostream&) const;
 
 
        // Member operators
 
        virtual void operator=(const UList<Type>&) {}
 
        virtual void operator=(const fvPatchField<Type>&) {}
        virtual void operator+=(const fvPatchField<Type>&) {}
        virtual void operator-=(const fvPatchField<Type>&) {}
        virtual void operator*=(const fvPatchField<scalar>&) {}
        virtual void operator/=(const fvPatchField<scalar>&) {}
 
        virtual void operator+=(const Field<Type>&) {}
        virtual void operator-=(const Field<Type>&) {}
 
        virtual void operator*=(const Field<scalar>&) {}
        virtual void operator/=(const Field<scalar>&) {}
 
        virtual void operator=(const Type&) {}
        virtual void operator+=(const Type&) {}
        virtual void operator-=(const Type&) {}
        virtual void operator*=(const scalar) {}
        virtual void operator/=(const scalar) {}
    };
 
 
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "coupledFixedValueFvPatchField.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //