labelField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2026 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 Typedef
25  Foam::labelField
26 
27 Description
28  Specialisation of Field<T> for label.
29 
30 SourceFiles
31  labelField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef labelField_H
36 #define labelField_H
37 
38 #include "label.H"
39 #include "Field.H"
40 
41 #define TEMPLATE
42 #include "FieldFunctionsM.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 typedef Field<label> labelField;
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 UNARY_FUNCTION(label, label, mag)
54 BINARY_TYPE_OPERATOR(label, label, label, +, add)
55 BINARY_TYPE_OPERATOR(label, label, label, -, subtract)
56 
57 
58 template<>
59 tmp<labelField> labelField::component(const direction) const;
60 
61 template<>
62 void component(labelField& lf, const labelUList& f, const direction);
63 
64 template<>
65 void labelField::replace(const direction, const labelUList& lf);
66 
67 
68 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
69 
70 } // End namespace Foam
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 #include "undefFieldFunctionsM.H"
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #endif
79 
80 // ************************************************************************* //
BINARY_TYPE_OPERATOR
#define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpName, OpFunc)
Definition: DimensionedFieldFunctionsM.C:778
UNARY_FUNCTION
#define UNARY_FUNCTION(ReturnType, Type1, Func, Dfunc)
Definition: DimensionedFieldFunctionsM.C:30
FieldFunctionsM.H
High performance macro functions for Field<Type> algebra. These expand using either array element acc...
Foam::Field< label >::replace
void replace(const direction, const UList< cmptType > &)
Replace a component field of the field.
Definition: Field.C:498
Foam::Field< label >::component
tmp< Field< cmptType > > component(const direction) const
Return a component field of the field.
Definition: Field.C:486
Foam::tmp
A class for managing temporary objects.
Definition: tmp.H:55
Foam
Namespace for OpenFOAM.
Definition: atmosphericBoundaryLayer.C:32
Foam::subtract
void subtract(GeometricField< typename typeOfSum< Type1, Type2 >::type, GeoMesh, PrimitiveField1 > &gf, const GeometricField< Type1, GeoMesh, PrimitiveField2 > &gf1, const GeometricField< Type2, GeoMesh, PrimitiveField3 > &gf2)
Definition: GeometricFieldFunctions.C:1002
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::add
void add(GeometricField< typename typeOfSum< Type1, Type2 >::type, GeoMesh, PrimitiveField1 > &gf, const GeometricField< Type1, GeoMesh, PrimitiveField2 > &gf1, const GeometricField< Type2, GeoMesh, PrimitiveField3 > &gf2)
Definition: GeometricFieldFunctions.C:1001
Foam::component
void component(GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField1 >::cmptType, GeoMesh, PrimitiveField1 > &gcf, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const direction d)
Definition: GeometricFieldFunctions.C:63
Foam::labelField
Field< label > labelField
Specialisation of Field<T> for label.
Definition: labelField.H:49
Foam::mag
tmp< DimensionedField< scalar, GeoMesh, Field > > mag(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
Definition: DimensionedFieldFunctions.C:238
Foam::direction
uint8_t direction
Definition: direction.H:45
f
labelList f(nPoints)