/usr/include/freefoam/OpenFOAM/Field.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::Field
Description
Generic templated field type.
SourceFiles
FieldFunctions.H
FieldFunctionsM.H
FieldMapper.H
FieldM.H
Field.C
FieldFunctions.C
FieldFunctionsM.C
\*---------------------------------------------------------------------------*/
#ifndef Field_H
#define Field_H
#include <OpenFOAM/tmp.H>
#include <OpenFOAM/direction.H>
#include <OpenFOAM/VectorSpace.H>
#include <OpenFOAM/scalarList.H>
#include <OpenFOAM/labelList.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class Type>
class Field;
//- Pre-declare related SubField type
template<class Type>
class SubField;
template<class Type>
Ostream& operator<<(Ostream&, const Field<Type>&);
template<class Type>
Ostream& operator<<(Ostream&, const tmp<Field<Type> >&);
class FieldMapper;
class dictionary;
/*---------------------------------------------------------------------------*\
Class Field Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Field
:
public refCount,
public List<Type>
{
public:
//- Component type
typedef typename pTraits<Type>::cmptType cmptType;
//- Declare type of subField
typedef SubField<Type> subField;
// Static data members
static const char* const typeName;
// Static Member Functions
//- Return a null field
inline static const Field<Type>& null()
{
return *reinterpret_cast< Field<Type>* >(0);
}
// Constructors
//- Construct null
// Used for temporary fields which are initialised after construction
Field();
//- Construct given size
// Used for temporary fields which are initialised after construction
explicit Field(const label);
//- Construct given size and initial value
Field(const label, const Type&);
//- Construct as copy of a UList\<Type\>
explicit Field(const UList<Type>&);
//- Construct by transferring the List contents
explicit Field(const Xfer<List<Type> >&);
//- Construct by 1 to 1 mapping from the given field
Field
(
const UList<Type>& mapF,
const unallocLabelList& mapAddressing
);
//- Construct by 1 to 1 mapping from the given tmp field
Field
(
const tmp<Field<Type> >& tmapF,
const unallocLabelList& mapAddressing
);
//- Construct by interpolative mapping from the given field
Field
(
const UList<Type>& mapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Construct by interpolative mapping from the given tmp field
Field
(
const tmp<Field<Type> >& tmapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Construct by mapping from the given field
Field
(
const UList<Type>& mapF,
const FieldMapper& map
);
//- Construct by mapping from the given tmp field
Field
(
const tmp<Field<Type> >& tmapF,
const FieldMapper& map
);
//- Construct as copy
Field(const Field<Type>&);
//- Construct as copy or re-use as specified.
Field(Field<Type>&, bool reUse);
//- Construct by transferring the Field contents
Field(const Xfer<Field<Type> >&);
//- Construct as copy of subField
Field(const typename Field<Type>::subField&);
//- Construct as copy of tmp<Field>
# ifdef ConstructFromTmp
Field(const tmp<Field<Type> >&);
# endif
//- Construct from Istream
Field(Istream&);
//- Construct from a dictionary entry
Field(const word& keyword, const dictionary& dict, const label size);
//- Clone
tmp<Field<Type> > clone() const;
//- Return a pointer to a new calculatedFvPatchFieldField created on
// freestore without setting patchField values
template<class Type2>
static tmp<Field<Type> > NewCalculatedType(const Field<Type2>& f)
{
return tmp<Field<Type> >(new Field<Type>(f.size()));
}
// Member Functions
//- 1 to 1 map from the given field
void map
(
const UList<Type>& mapF,
const unallocLabelList& mapAddressing
);
//- 1 to 1 map from the given tmp field
void map
(
const tmp<Field<Type> >& tmapF,
const unallocLabelList& mapAddressing
);
//- Interpolative map from the given field
void map
(
const UList<Type>& mapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Interpolative map from the given tmp field
void map
(
const tmp<Field<Type> >& tmapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Map from the given field
void map
(
const UList<Type>& mapF,
const FieldMapper& map
);
//- Map from the given tmp field
void map
(
const tmp<Field<Type> >& tmapF,
const FieldMapper& map
);
//- Map from self
void autoMap
(
const FieldMapper& map
);
//- 1 to 1 reverse-map from the given field
void rmap
(
const UList<Type>& mapF,
const unallocLabelList& mapAddressing
);
//- 1 to 1 reverse-map from the given tmp field
void rmap
(
const tmp<Field<Type> >& tmapF,
const unallocLabelList& mapAddressing
);
//- Interpolative reverse map from the given field
void rmap
(
const UList<Type>& mapF,
const unallocLabelList& mapAddressing,
const scalarList& weights
);
//- Interpolative reverse map from the given tmp field
void rmap
(
const tmp<Field<Type> >& tmapF,
const unallocLabelList& mapAddressing,
const scalarList& weights
);
//- Negate this field
void negate();
//- Return a component field of the field
tmp<Field<cmptType> > component(const direction) const;
//- Replace a component field of the field
void replace(const direction, const UList<cmptType>&);
//- Replace a component field of the field
void replace(const direction, const tmp<Field<cmptType> >&);
//- Replace a component field of the field
void replace(const direction, const cmptType&);
//- Return the field transpose (only defined for second rank tensors)
tmp<Field<Type> > T() const;
//- Write the field as a dictionary entry
void writeEntry(const word& keyword, Ostream& os) const;
// Member operators
void operator=(const Field<Type>&);
void operator=(const UList<Type>&);
void operator=(const SubField<Type>&);
void operator=(const tmp<Field<Type> >&);
void operator=(const Type&);
template<class Form, class Cmpt, int nCmpt>
void operator=(const VectorSpace<Form,Cmpt,nCmpt>&);
void operator+=(const UList<Type>&);
void operator+=(const tmp<Field<Type> >&);
void operator-=(const UList<Type>&);
void operator-=(const tmp<Field<Type> >&);
void operator*=(const UList<scalar>&);
void operator*=(const tmp<Field<scalar> >&);
void operator/=(const UList<scalar>&);
void operator/=(const tmp<Field<scalar> >&);
void operator+=(const Type&);
void operator-=(const Type&);
void operator*=(const scalar&);
void operator/=(const scalar&);
// IOstream operators
friend Ostream& operator<< <Type>
(Ostream&, const Field<Type>&);
friend Ostream& operator<< <Type>
(Ostream&, const tmp<Field<Type> >&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "FieldFunctions.H"
#ifdef NoRepository
# include "Field.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|