timeVaryingUniformFixedValuePointPatchField.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) 2011-2015 OpenFOAM Foundation
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::timeVaryingUniformFixedValuePointPatchField
26 
27 Description
28  A time-varying form of a uniform fixed value boundary condition.
29 
30 See Also
31  Foam::timeVaryingUniformFixedValueFvField
32 
33 SourceFiles
34  timeVaryingUniformFixedValuePointPatchField.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef timeVaryingUniformFixedValuePointPatchField_H
39 #define timeVaryingUniformFixedValuePointPatchField_H
40 
42 #include "interpolationTable.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class timeVaryingUniformFixedValuePointPatchField Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class Type>
55 :
56  public fixedValuePointPatchField<Type>
57 {
58  // Private data
59 
60  //- The time series being used, including the bounding treatment
61  interpolationTable<Type> timeSeries_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("timeVaryingUniformFixedValue");
68 
69 
70  // Constructors
71 
72  //- Construct from patch and internal field
74  (
75  const pointPatch&,
77  );
78 
79  //- Construct from patch, internal field and dictionary
81  (
82  const pointPatch&,
84  const dictionary&
85  );
86 
87  //- Construct by mapping given patch field onto a new patch
89  (
91  const pointPatch&,
94  );
95 
96  //- Construct as copy
98  (
100  );
101 
102  //- Construct and return a clone
103  virtual autoPtr<pointPatchField<Type> > clone() const
104  {
106  (
108  );
109  }
110 
111  //- Construct as copy setting internal field reference
113  (
116  );
117 
118  //- Construct and return a clone setting internal field reference
120  (
122  ) const
123  {
125  (
127  );
128  }
129 
130 
131  // Member functions
132 
133  // Access
134 
135  //- Return the time series used
136  const interpolationTable<Type>& timeSeries() const
137  {
138  return timeSeries_;
139  }
140 
141 
142  // Evaluation functions
143 
144  //- Update the coefficients associated with the patch field
145  virtual void updateCoeffs();
146 
147 
148  //- Write
149  virtual void write(Ostream&) const;
150 };
151 
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 } // End namespace Foam
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #ifdef NoRepository
161 #endif
162 
163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164 
165 #endif
166 
167 // ************************************************************************* //
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
An interpolation/look-up table of scalar vs <Type> values. The reference scalar values must be monoto...
const interpolationTable< Type > & timeSeries() const
Return the time series used.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A time-varying form of a uniform fixed value boundary condition.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Namespace for OpenFOAM.
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
TypeName("timeVaryingUniformFixedValue")
Runtime type information.
Foam::pointPatchFieldMapper.
timeVaryingUniformFixedValuePointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
A FixedValue boundary condition for pointField.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117