FreeFOAM The Cross-Platform CFD Toolkit
fixedInternalValueFvPatchField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::fixedInternalValueFvPatchField
26 
27 Description
28  Boundary condition providing mechanism to set boundary (cell) values
29  directly into a matrix, i.e. to set a constraint condition. Default
30  behaviour is to act as a zero gradient condition.
31 
32 SourceFiles
33  fixedInternalValueFvPatchField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef fixedInternalValueFvPatchField_H
38 #define fixedInternalValueFvPatchField_H
39 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class fixedInternalValueFvPatchField Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
53 :
54  public zeroGradientFvPatchField<Type>
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("fixedInternalValue");
61 
62 
63  // Constructors
64 
65  //- Construct from patch and internal field
67  (
68  const fvPatch&,
70  );
71 
72  //- Construct from patch, internal field and dictionary
74  (
75  const fvPatch&,
77  const dictionary&
78  );
79 
80  //- Construct by mapping the given fixedInternalValueFvPatchField<Type>
81  // onto a new patch
83  (
85  const fvPatch&,
87  const fvPatchFieldMapper&
88  );
89 
90  //- Construct as copy
92  (
94  );
95 
96  //- Construct and return a clone
97  virtual tmp<fvPatchField<Type> > clone() const
98  {
99  return tmp<fvPatchField<Type> >
100  (
102  );
103  }
104 
105  //- Construct as copy setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
113  virtual tmp<fvPatchField<Type> > clone
114  (
116  ) const
117  {
118  return tmp<fvPatchField<Type> >
119  (
121  );
122  }
123 
124 
125  // Member functions
126 
127  // Evaluation functions
128 
129  //-Manipulate a matrix
130  virtual void manipulateMatrix(fvMatrix<Type>& matrix);
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #ifdef NoRepository
142 #endif
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #endif
147 
148 // ************************ vim: set sw=4 sts=4 et: ************************ //