alphaFixedPressureFvPatchScalarField.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-2013 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::alphaFixedPressureFvPatchScalarField
26 
27 Description
28  A fixed-pressure alphaContactAngle boundary
29 
30 SourceFiles
31  alphaFixedPressureFvPatchScalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef alphaFixedPressureFvPatchScalarField_H
36 #define alphaFixedPressureFvPatchScalarField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class alphaFixedPressureFvPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public fixedValueFvPatchScalarField
52 {
53  // Private data
54 
55  //- Fixed pressure
57 
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("alphaFixedPressure");
63 
64 
65  // Constructors
66 
67  //- Construct from patch and internal field
69  (
70  const fvPatch&,
72  );
73 
74  //- Construct from patch, internal field and dictionary
76  (
77  const fvPatch&,
79  const dictionary&
80  );
81 
82  //- Construct by mapping given alphaFixedPressureFvPatchScalarField
83  // onto a new patch
85  (
87  const fvPatch&,
89  const fvPatchFieldMapper&
90  );
91 
92  //- Construct as copy
94  (
96  );
97 
98  //- Construct and return a clone
99  virtual tmp<fvPatchScalarField> clone() const
100  {
102  (
104  );
105  }
106 
107  //- Construct as copy setting internal field reference
109  (
112  );
113 
114  //- Construct and return a clone setting internal field reference
116  (
118  ) const
119  {
121  (
123  );
124  }
125 
126 
127  // Member functions
128 
129  // Access
130 
131  //- Return the alphaFixed pressure
132  const scalarField& p() const
133  {
134  return p_;
135  }
136 
137  //- Return reference to the alphaFixed pressure to allow adjustment
138  scalarField& p()
139  {
140  return p_;
141  }
142 
143 
144  // Mapping functions
145 
146  //- Map (and resize as needed) from self given a mapping object
147  virtual void autoMap
148  (
149  const fvPatchFieldMapper&
150  );
151 
152  //- Reverse map the given fvPatchField onto this fvPatchField
153  virtual void rmap
154  (
155  const fvPatchScalarField&,
156  const labelList&
157  );
158 
159 
160  // Evaluation functions
161 
162  //- Update the coefficients associated with the patch field
163  virtual void updateCoeffs();
164 
165 
166  //- Write
167  virtual void write(Ostream&) const;
168 };
169 
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 } // End namespace Foam
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #endif
178 
179 // ************************************************************************* //
Foam::fvPatchField
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::alphaFixedPressureFvPatchScalarField::rmap
virtual void rmap(const fvPatchScalarField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: alphaFixedPressureFvPatchScalarField.C:122
Foam::alphaFixedPressureFvPatchScalarField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: alphaFixedPressureFvPatchScalarField.C:112
Foam::alphaFixedPressureFvPatchScalarField::p_
scalarField p_
Fixed pressure.
Definition: alphaFixedPressureFvPatchScalarField.H:55
Foam::alphaFixedPressureFvPatchScalarField::TypeName
TypeName("alphaFixedPressure")
Runtime type information.
Foam::Field
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField
alphaFixedPressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Definition: alphaFixedPressureFvPatchScalarField.C:37
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::alphaFixedPressureFvPatchScalarField
A fixed-pressure alphaContactAngle boundary.
Definition: alphaFixedPressureFvPatchScalarField.H:48
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::alphaFixedPressureFvPatchScalarField::p
const scalarField & p() const
Return the alphaFixed pressure.
Definition: alphaFixedPressureFvPatchScalarField.H:131
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::alphaFixedPressureFvPatchScalarField::p
scalarField & p()
Return reference to the alphaFixed pressure to allow adjustment.
Definition: alphaFixedPressureFvPatchScalarField.H:137
fixedValueFvPatchFields.H
Foam::alphaFixedPressureFvPatchScalarField::write
virtual void write(Ostream &) const
Write.
Definition: alphaFixedPressureFvPatchScalarField.C:156
Foam::alphaFixedPressureFvPatchScalarField::clone
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Definition: alphaFixedPressureFvPatchScalarField.H:98
Foam::alphaFixedPressureFvPatchScalarField::updateCoeffs
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: alphaFixedPressureFvPatchScalarField.C:136
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:45
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:53
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:51