cellMotionFvPatchField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::cellMotionFvPatchField
28 
29 Description
30  Foam::cellMotionFvPatchField
31 
32 SourceFiles
33  cellMotionFvPatchField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef cellMotionFvPatchField_H
38 #define cellMotionFvPatchField_H
39 
40 #include "Random.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class cellMotionFvPatch Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class Type>
54 :
55  public fixedValueFvPatchField<Type>
56 {
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("cellMotion");
62 
63 
64  // Constructors
65 
66  //- Construct from patch and internal field
68  (
69  const fvPatch&,
71  );
72 
73  //- Construct from patch, internal field and dictionary
75  (
76  const fvPatch&,
78  const dictionary&
79  );
80 
81  //- Construct by mapping given cellMotionFvPatchField
82  // onto a new patch
84  (
86  const fvPatch&,
88  const fvPatchFieldMapper&
89  );
90 
91  //- Construct as copy
93  (
95  );
96 
97  //- Construct and return a clone
98  virtual tmp<fvPatchField<Type>> clone() const
99  {
100  return tmp<fvPatchField<Type>>
101  (
103  );
104  }
105 
106  //- Construct as copy setting internal field reference
108  (
111  );
112 
113  //- Construct and return a clone setting internal field reference
115  (
117  ) const
118  {
119  return tmp<fvPatchField<Type>>
120  (
121  new cellMotionFvPatchField<Type>(*this, iF)
122  );
123  }
124 
125 
126  // Member functions
127 
128  //- Update the coefficients associated with the patch field
129  virtual void updateCoeffs();
130 
131  //- Write
132  virtual void write(Ostream&) const;
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #ifdef NoRepository
143  #include "cellMotionFvPatchField.C"
144 #endif
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
Foam::cellMotionFvPatchField::TypeName
TypeName("cellMotion")
Runtime type information.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::fixedValueFvPatchField
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
Definition: fixedValueFvPatchField.H:80
cellMotionFvPatchField.C
Foam::cellMotionFvPatchField
Foam::cellMotionFvPatchField.
Definition: cellMotionFvPatchField.H:52
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::cellMotionFvPatchField::write
virtual void write(Ostream &) const
Write.
Definition: cellMotionFvPatchField.C:126
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::cellMotionFvPatchField::clone
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Definition: cellMotionFvPatchField.H:97
Random.H
fixedValueFvPatchFields.H
Foam::cellMotionFvPatchField::cellMotionFvPatchField
cellMotionFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: cellMotionFvPatchField.C:38
Foam::cellMotionFvPatchField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: cellMotionFvPatchField.C:96
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54