fixedValueFvsPatchField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2016 OpenFOAM Foundation
    Copyright (C) 2024 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::fixedValueFvsPatchField
 
Description
    This boundary condition supplies a fixed value constraint, and is the base
    class for a number of other boundary conditions.
 
    The "value" entry is MUST_READ.
 
Usage
    \table
        Property     | Description             | Required    | Default
        value        | Patch face values       | yes         |
    \endtable
 
    Example of the boundary condition specification:
    \verbatim
    <patchName>
    {
        type    fixedValue;
        value   uniform 0;  // Example for scalar field usage
    }
    \endverbatim
 
SourceFiles
    fixedValueFvsPatchField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_fixedValueFvsPatchField_H
#define Foam_fixedValueFvsPatchField_H
 
#include "fvsPatchField.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                   Class fixedValueFvsPatchField Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class fixedValueFvsPatchField
:
    public fvsPatchField<Type>
{
public:
 
    //- Runtime type information
    TypeName("fixedValue");
 
 
    // Constructors
 
        //- Construct from patch and internal field
        fixedValueFvsPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, surfaceMesh>&
        );
 
        //- Construct from patch, internal field and value
        fixedValueFvsPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, surfaceMesh>&,
            const Type& value
        );
 
        //- Construct from patch, internal field and dictionary
        fixedValueFvsPatchField
        (
            const fvPatch&,
            const DimensionedField<Type, surfaceMesh>&,
            const dictionary&,
            IOobjectOption::readOption requireValue = IOobjectOption::MUST_READ
        );
 
        //- Construct by mapping the given fixedValue patch field
        //- onto a new patch
        fixedValueFvsPatchField
        (
            const fixedValueFvsPatchField<Type>&,
            const fvPatch&,
            const DimensionedField<Type, surfaceMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Copy construct onto a new patch with internal field reference
        //- and specified value
        fixedValueFvsPatchField
        (
            const fixedValueFvsPatchField<Type>& pfld,
            const fvPatch& p,
            const DimensionedField<Type, surfaceMesh>& iF,
            const Type& value
        );
 
        //- Copy construct with internal field reference
        fixedValueFvsPatchField
        (
            const fixedValueFvsPatchField<Type>& pfld,
            const DimensionedField<Type, surfaceMesh>& iF
        );
 
        //- Copy construct
        fixedValueFvsPatchField(const fixedValueFvsPatchField<Type>& pfld)
        :
            fixedValueFvsPatchField<Type>(pfld, pfld.internalField())
        {}
 
 
        //- Return clone
        virtual tmp<fvsPatchField<Type>> clone() const
        {
            return fvsPatchField<Type>::Clone(*this);
        }
 
        //- Clone with an internal field reference
        virtual tmp<fvsPatchField<Type>> clone
        (
            const DimensionedField<Type, surfaceMesh>& iF
        ) const
        {
            return fvsPatchField<Type>::Clone(*this, iF);
        }
 
 
    // Member Functions
 
        //- True: this patch field fixes a value.
        virtual bool fixesValue() const { return true; }
 
        //- False: this patch field is not altered by assignment.
        virtual bool assignable() const { return false; }
 
        //- Write includes "value" entry
        virtual void write(Ostream&) const;
 
 
        // 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;
 
 
    // Member Operators
 
        virtual void operator=(const UList<Type>&) {}
 
        virtual void operator=(const fvsPatchField<Type>&) {}
        virtual void operator+=(const fvsPatchField<Type>&) {}
        virtual void operator-=(const fvsPatchField<Type>&) {}
        virtual void operator*=(const fvsPatchField<scalar>&) {}
        virtual void operator/=(const fvsPatchField<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 "fixedValueFvsPatchField.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //