All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SubFieldI.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-2023 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
27 
28 template<class Type>
30 (
31  const SubList<Type>& list
32 )
33 :
34  SubList<Type>(list)
35 {}
36 
37 
38 template<class Type>
40 (
41  const UList<Type>& list
42 )
43 :
44  SubList<Type>(list, list.size())
45 {}
46 
47 
48 template<class Type>
50 (
51  const UList<Type>& list,
52  const label subSize
53 )
54 :
55  SubList<Type>(list, subSize)
56 {}
57 
58 
59 template<class Type>
61 (
62  const UList<Type>& list,
63  const label subSize,
64  const label startIndex
65 )
66 :
67  SubList<Type>(list, subSize, startIndex)
68 {}
69 
70 
71 template<class Type>
73 (
74  const SubField<Type>& sfield
75 )
76 :
77  tmp<SubField<Type>>::refCount(),
78  SubList<Type>(sfield)
79 {}
80 
81 
82 template<class Type>
84 (
85  SubField<Type>& sfield,
86  bool reuse
87 )
88 :
89  tmp<SubField<Type>>::refCount(),
90  SubList<Type>(sfield)
91 {}
92 
93 
94 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
95 
96 template<class Type>
98 {
99  return NullObjectRef<SubField<Type>>();
100 }
101 
102 
103 template<class Type>
106 (
107  const direction d
108 ) const
109 {
110  return (reinterpret_cast<const Field<Type>&>(*this)).component(d);
111 }
112 
113 
114 template<class Type>
116 {
117  return (reinterpret_cast<const Field<Type>&>(*this)).T();
118 }
119 
120 
121 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
122 
123 template<class Type>
125 {
127 }
128 
129 
130 template<class Type>
132 {
134 }
135 
136 
137 template<class Type>
138 inline void Foam::SubField<Type>::operator=(const Type& rhs)
139 {
141 }
142 
143 
144 template<class Type>
145 template<class Form, Foam::direction Ncmpts>
147 (
149 )
150 {
151  forAll(rhs, i)
152  {
153  this->operator[](i) = rhs[i];
154  }
155 }
156 
157 
158 template<class Type>
160 {
161  return *reinterpret_cast<const Field<Type>* >(this);
162 }
163 
164 
165 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
Pre-declare SubField and related Field type.
Definition: Field.H:83
Pre-declare related SubField type.
Definition: SubField.H:63
static const SubField< Type > & null()
Return a null SubField.
Definition: SubFieldI.H:97
void operator=(const SubField< Type > &)
Assignment via UList operator. Takes linear time.
Definition: SubFieldI.H:124
tmp< Field< Type > > T() const
Return the field transpose (only defined for second rank tensors)
Definition: SubFieldI.H:115
SubField(const SubList< Type > &)
Construct from a SubList.
Definition: SubFieldI.H:30
tmp< Field< cmptType > > component(const direction) const
Return a component field of the field.
Definition: SubFieldI.H:106
void operator=(const SubList< T > &)
Assignment of all entries to the given sub-list.
Definition: SubListI.H:91
Templated vector space.
Definition: VectorSpace.H:85
Reference counter for various OpenFOAM components.
Definition: refCount.H:50
A class for managing temporary objects.
Definition: tmp.H:55
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
uint8_t direction
Definition: direction.H:45