Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / applications / solvers / compressible / rhoCentralFoam / BCs / mixedFixedValueSlip / mixedFixedValueSlipFvPatchField.H
blob5a1238a171348afb986335caee5290f1fd70399f
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::mixedFixedValueSlipFvPatchField
27 Description
28     A mixed boundary type that blends between fixedValue and slip, as opposed
29     to the standard mixed condition that blends between fixedValue and
30     fixedGradient; required to implement maxwellSlipU condition.
32 SourceFiles
33     mixedFixedValueSlipFvPatchField.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef mixedFixedValueSlipFvPatchField_H
38 #define mixedFixedValueSlipFvPatchField_H
40 #include "transformFvPatchField.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                       Class mixedFixedValueSlipFvPatch Declaration
49 \*---------------------------------------------------------------------------*/
51 template<class Type>
52 class mixedFixedValueSlipFvPatchField
54     public transformFvPatchField<Type>
56     // Private data
58         //- Value field used for boundary condition
59         Field<Type> refValue_;
61         //- Fraction (0-1) of value used for boundary condition
62         scalarField valueFraction_;
64 public:
66     //- Runtime type information
67     TypeName("mixedFixedValueSlip");
70     // Constructors
72         //- Construct from patch and internal field
73         mixedFixedValueSlipFvPatchField
74         (
75             const fvPatch&,
76             const DimensionedField<Type, volMesh>&
77         );
79         //- Construct from patch, internal field and dictionary
80         mixedFixedValueSlipFvPatchField
81         (
82             const fvPatch&,
83             const DimensionedField<Type, volMesh>&,
84             const dictionary&
85         );
87         //- Construct by mapping given mixedFixedValueSlipFvPatchField
88         //- onto a new patch
89         mixedFixedValueSlipFvPatchField
90         (
91             const mixedFixedValueSlipFvPatchField<Type>&,
92             const fvPatch&,
93             const DimensionedField<Type, volMesh>&,
94             const fvPatchFieldMapper&
95         );
97         //- Construct as copy
98         mixedFixedValueSlipFvPatchField
99         (
100             const mixedFixedValueSlipFvPatchField<Type>&
101         );
103         //- Construct and return a clone
104         virtual tmp<fvPatchField<Type> > clone() const
105         {
106             return tmp<fvPatchField<Type> >
107             (
108                 new mixedFixedValueSlipFvPatchField<Type>(*this)
109             );
110         }
112         //- Construct as copy setting internal field reference
113         mixedFixedValueSlipFvPatchField
114         (
115             const mixedFixedValueSlipFvPatchField<Type>&,
116             const DimensionedField<Type, volMesh>&
117         );
119         //- Construct and return a clone setting internal field reference
120         virtual tmp<fvPatchField<Type> > clone
121         (
122             const DimensionedField<Type, volMesh>& iF
123         ) const
124         {
125             return tmp<fvPatchField<Type> >
126             (
127                 new mixedFixedValueSlipFvPatchField<Type>(*this, iF)
128             );
129         }
131     // Member functions
133         // Mapping functions
135             //- Map (and resize as needed) from self given a mapping object
136             virtual void autoMap
137             (
138                 const fvPatchFieldMapper&
139             );
141             //- Reverse map the given fvPatchField onto this fvPatchField
142             virtual void rmap
143             (
144                 const fvPatchField<Type>&,
145                 const labelList&
146             );
148         // Return defining fields
150             virtual Field<Type>& refValue()
151             {
152                 return refValue_;
153             }
155             virtual const Field<Type>& refValue() const
156             {
157                 return refValue_;
158             }
160             virtual scalarField& valueFraction()
161             {
162                 return valueFraction_;
163             }
165             virtual const scalarField& valueFraction() const
166             {
167                 return valueFraction_;
168             }
170         // Evaluation functions
172             //- Return gradient at boundary
173             virtual tmp<Field<Type> > snGrad() const;
175             //- Evaluate the patch field
176             virtual void evaluate
177             (
178                 const Pstream::commsTypes commsType=Pstream::blocking
179             );
181             //- Return face-gradient transform diagonal
182             virtual tmp<Field<Type> > snGradTransformDiag() const;
185         //- Write
186         virtual void write(Ostream&) const;
189     // Member operators
191         virtual void operator=(const UList<Type>&) {}
193         virtual void operator=(const fvPatchField<Type>&) {}
194         virtual void operator+=(const fvPatchField<Type>&) {}
195         virtual void operator-=(const fvPatchField<Type>&) {}
196         virtual void operator*=(const fvPatchField<scalar>&) {}
197         virtual void operator/=(const fvPatchField<scalar>&) {}
199         virtual void operator+=(const Field<Type>&) {}
200         virtual void operator-=(const Field<Type>&) {}
202         virtual void operator*=(const Field<scalar>&) {}
203         virtual void operator/=(const Field<scalar>&) {}
205         virtual void operator=(const Type&) {}
206         virtual void operator+=(const Type&) {}
207         virtual void operator-=(const Type&) {}
208         virtual void operator*=(const scalar) {}
209         virtual void operator/=(const scalar) {}
213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
215 } // End namespace Foam
217 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
219 #ifdef NoRepository
220 #   include "mixedFixedValueSlipFvPatchField.C"
221 #endif
223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
225 #endif
227 // ************************************************************************* //