SubFieldI.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-2016 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 :
78  SubList<Type>(sfield)
79 {}
80 
81 
82 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
83 
84 template<class Type>
86 {
87  return NullObjectRef<SubField<Type>>();
88 }
89 
90 
91 template<class Type>
94 (
95  const direction d
96 ) const
97 {
98  return (reinterpret_cast<const Field<Type>&>(*this)).component(d);
99 }
100 
101 
102 template<class Type>
104 {
105  return (reinterpret_cast<const Field<Type>&>(*this)).T();
106 }
107 
108 
109 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
110 
111 template<class Type>
113 {
115 }
116 
117 
118 template<class Type>
120 {
122 }
123 
124 
125 template<class Type>
126 template<class Form, Foam::direction Ncmpts>
127 inline void Foam::SubField<Type>::operator=
128 (
130 )
131 {
132  forAll(rhs, i)
133  {
134  this->operator[](i) = rhs[i];
135  }
136 }
137 
138 
139 template<class Type>
140 inline Foam::SubField<Type>::operator const Foam::Field<Type>&() const
141 {
142  return *reinterpret_cast<const Field<Type>* >(this);
143 }
144 
145 
146 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
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:46
Reference counter for various OpenFOAM components.
Definition: refCount.H:49
Templated vector space.
Definition: VectorSpace.H:53
void operator=(const SubField< Type > &)
Assignment via UList operator. Takes linear time.
Definition: SubFieldI.H:112
SubField(const SubList< Type > &)
Construct from a SubList.
Definition: SubFieldI.H:30
Pre-declare related SubField type.
Definition: Field.H:61
Pre-declare SubField and related Field type.
Definition: Field.H:57
tmp< Field< cmptType > > component(const direction) const
Return a component field of the field.
Definition: SubFieldI.H:94
tmp< Field< Type > > T() const
Return the field transpose (only defined for second rank tensors)
Definition: SubFieldI.H:103
label size() const
Return the number of elements in the UList.
Definition: UListI.H:299
A class for managing temporary objects.
Definition: PtrList.H:54
static const SubField< Type > & null()
Return a null SubField.
Definition: SubFieldI.H:85