processorFvsPatchField.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::processorFvsPatchField
26 
27 Description
28  Foam::processorFvsPatchField
29 
30 SourceFiles
31  processorFvsPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef processorFvsPatchField_H
36 #define processorFvsPatchField_H
37 
38 #include "coupledFvsPatchField.H"
39 #include "processorFvPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class processorFvsPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public coupledFvsPatchField<Type>
54 {
55  // Private data
56 
57  //- Local reference cast into the processor patch
58  const processorFvPatch& procPatch_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName(processorFvPatch::typeName_());
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const fvPatch&,
74  );
75 
76  //- Construct from patch and internal field and patch field
78  (
79  const fvPatch&,
81  const Field<Type>&
82  );
83 
84  //- Construct from patch, internal field and dictionary
86  (
87  const fvPatch&,
89  const dictionary&
90  );
91 
92  //- Construct by mapping given processorFvsPatchField onto a new patch
94  (
96  const fvPatch&,
98  const fvPatchFieldMapper&
99  );
100 
101  //- Construct as copy
103 
104  //- Construct and return a clone
105  virtual tmp<fvsPatchField<Type> > clone() const
106  {
107  return tmp<fvsPatchField<Type> >
108  (
110  );
111  }
112 
113  //- Construct as copy setting internal field reference
115  (
118  );
119 
120  //- Construct and return a clone setting internal field reference
122  (
124  ) const
125  {
126  return tmp<fvsPatchField<Type> >
127  (
128  new processorFvsPatchField<Type>(*this, iF)
129  );
130  }
131 
132 
133  //- Destructor
134  virtual ~processorFvsPatchField();
135 
136 
137  // Member functions
138 
139  // Access
140 
141  //- Return true if running parallel
142  virtual bool coupled() const
143  {
144  if (Pstream::parRun())
145  {
146  return true;
147  }
148  else
149  {
150  return false;
151  }
152  }
153 };
154 
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 } // End namespace Foam
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #ifdef NoRepository
163 # include "processorFvsPatchField.C"
164 #endif
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 #endif
169 
170 // ************************************************************************* //
virtual bool coupled() const
Return true if running parallel.
static bool & parRun()
Is this a parallel run?
Definition: UPstream.H:380
processorFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual ~processorFvsPatchField()
Destructor.
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual tmp< fvsPatchField< Type > > clone() const
Construct and return a clone.
Pre-declare SubField and related Field type.
Definition: Field.H:57
Foam::coupledFvsPatchField.
TypeName(processorFvPatch::typeName_())
Runtime type information.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::processorFvsPatchField.
Processor patch.
A class for managing temporary objects.
Definition: PtrList.H:118