File size: 11,217 Bytes
5a600cf | 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2024-2026 OpenFOAM Foundation
\\/ 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::OldTimeField
Description
Class to add into field types to provide old-time storage and retrieval
SourceFiles
OldTimeFieldI.H
OldTimeField.C
\*---------------------------------------------------------------------------*/
#ifndef OldTimeField_H
#define OldTimeField_H
#include "Time.H"
#include "VoidT.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
template<class FieldType>
class OldTimeField;
/*---------------------------------------------------------------------------*\
Class OldTimeField0Type Declaration
\*---------------------------------------------------------------------------*/
template<class FieldType>
struct OldTimeField0Type;
template
<
template<class, class, template<class> class> class GeoField,
class Type,
class GeoMesh,
template<class> class PrimitiveField
>
struct OldTimeField0Type<GeoField<Type, GeoMesh, PrimitiveField>>
{
typedef GeoField<Type, GeoMesh, PrimitiveField> type;
};
template<class Type>
class Field;
template<class Type>
class SubField;
template
<
template<class, class, template<class> class> class GeoField,
class Type,
class GeoMesh
>
struct OldTimeField0Type<GeoField<Type, GeoMesh, SubField>>
{
typedef GeoField<Type, GeoMesh, Field> type;
};
/*---------------------------------------------------------------------------*\
Class OldTimeOtherFieldType Declaration
\*---------------------------------------------------------------------------*/
template<class FieldType>
struct OldTimeOtherFieldType;
template
<
template<class, class, template<class> class> class GeoField,
class Type,
class GeoMesh,
template<class> class PrimitiveField
>
struct OldTimeOtherFieldType<GeoField<Type, GeoMesh, PrimitiveField>>
{
template<template<class> class OtherPrimitiveField>
using type = GeoField<Type, GeoMesh, OtherPrimitiveField>;
};
/*---------------------------------------------------------------------------*\
Class OldTimeField Declaration
\*---------------------------------------------------------------------------*/
template<class FieldType>
class OldTimeField
{
private:
// Private Typedefs
//- The old-time field type
typedef typename OldTimeField0Type<FieldType>::type Field0Type;
//- The field type based on a different primitive field type
template<template<class> class OtherPrimitiveField>
using OtherFieldType =
typename OldTimeOtherFieldType<FieldType>::
template type<OtherPrimitiveField>;
//- The old-time field class
typedef OldTimeField<FieldType> OldTime;
//- The old-time field class based on a different primitive field type
template<template<class> class OtherPrimitiveField>
using OtherOldTime =
OldTimeField<OtherFieldType<OtherPrimitiveField>>;
// Private Data
//- Current time index
mutable label timeIndex_;
//- The old-time field pointer or reference
mutable tmp<Field0Type> tfield0_;
// Private Member Functions
//- Get a reference to the field
const FieldType& field() const;
//- Get a non-const reference to the field
FieldType& fieldRef();
//- Store the old-time fields. Inner recursion. Overload for when the
// base class is not an old-time field.
void storeOldTimesInner(const nil&) const;
//- Store the old-time fields. Inner recursion. Overload for when the
// base class is an old-time field.
template<class OldTimeBaseField>
void storeOldTimesInner(const OldTimeBaseField& otbf) const;
//- Store the old-time fields. Inner recursion.
void storeOldTimesInner() const;
//- Set the oldest field pointer to nullObjectPtr. Inner recursion.
void nullOldestTimeInner();
//- Set the field reference in the base class. Overload for when the
// base class is not an old-time field.
void setBase(const nil&, const bool clear) const;
//- Set the field reference in the base class. Overload for when the
// base class is an old-time field.
template<class OldTimeBaseField>
void setBase(const OldTimeBaseField& otbf, const bool clear) const;
//- Set the field reference in the base class
void setBase(const bool clear = true) const;
protected:
// Protected Member Functions
//- Read old-time field from file if it is present
bool readOldTimeIfPresent();
//- Copy the old-times from the given field
template<template<class> class OtherPrimitiveField>
void copyOldTimes
(
const IOobject& io,
const OtherOldTime<OtherPrimitiveField>&
);
//- Copy the old-times from the given field
template<template<class> class OtherPrimitiveField>
void copyOldTimes
(
const word& newName,
const OtherOldTime<OtherPrimitiveField>&
);
public:
//- Declare friendship with other old-time fields
template<class OtherFieldType>
friend class OldTimeField;
//- Declare friendship with the base old-time field casting struct
template<class OtherFieldType, typename>
friend struct OldTimeBaseFieldType;
// Constructors
//- Construct from a time index
OldTimeField(const label timeIndex);
//- Copy construct
OldTimeField(const OldTimeField<FieldType>& otf);
//- Move construct
OldTimeField(OldTimeField<FieldType>&& otf);
//- Destructor
~OldTimeField();
// Member Functions
//- Return the time index of the field
inline label timeIndex() const;
//- Set the time index of the field
inline void setTimeIndex(const label);
//- Return whether or not this is an old-time field
bool isOldTime() const;
//- Return whether old-time fields have been stored yet
bool hasStoredOldTimes() const;
//- Reset the old-time field
void resetOldTime() const;
//- Store the old-time fields
void storeOldTimes() const;
//- Clear old-time fields
void clearOldTimes();
//- Set the oldest field pointer to nullObjectPtr. This removes the
// field whilst maintaining a tag distinct from nullptr so that the
// field can be reinstated on the next storeOldTimes.
void nullOldestTime();
//- Return the number of old-time fields stored
label nOldTimes(const bool includeNull=true) const;
//- Return the old-time field
const Field0Type& oldTime() const;
//- Return a non-const reference to the old-time field
Field0Type& oldTimeRef();
//- Return the n-th old-time field
const Field0Type& oldTime(const label n) const;
//- Return a non-const reference to the n-th old time field
Field0Type& oldTimeRef(const label n);
// Member Operators
//- Disallow default bitwise assignment
void operator=(const OldTimeField<FieldType>&) = delete;
};
/*---------------------------------------------------------------------------*\
Struct OldTimeBaseFieldType Declaration
\*---------------------------------------------------------------------------*/
template<class FieldType, typename = void>
struct OldTimeBaseFieldType
{
nil operator()(const OldTimeField<FieldType>& otf) const
{
return nil();
}
};
template<class FieldType>
struct OldTimeBaseFieldType<FieldType, VoidT<typename FieldType::Base::OldTime>>
{
typedef typename FieldType::Base::OldTime type;
const type& operator()(const OldTimeField<FieldType>& otf) const
{
return static_cast<const type&>(otf.field());
}
};
/*---------------------------------------------------------------------------*\
Struct OldTimeFieldCopy Declaration
\*---------------------------------------------------------------------------*/
template<class FieldType>
struct OldTimeFieldCopy
{
typedef typename OldTimeField0Type<FieldType>::type Field0Type;
tmp<Field0Type> operator()(const IOobject& io, const FieldType& field)
{
return tmp<Field0Type>(new Field0Type(io, field));
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#define USING_OLD_TIME_FIELD(FieldType) \
using OldTimeField<FieldType>::readOldTimeIfPresent; \
using OldTimeField<FieldType>::copyOldTimes; \
using OldTimeField<FieldType>::timeIndex; \
using OldTimeField<FieldType>::setTimeIndex; \
using OldTimeField<FieldType>::isOldTime; \
using OldTimeField<FieldType>::hasStoredOldTimes; \
using OldTimeField<FieldType>::resetOldTime; \
using OldTimeField<FieldType>::storeOldTimes; \
using OldTimeField<FieldType>::clearOldTimes; \
using OldTimeField<FieldType>::nullOldestTime; \
using OldTimeField<FieldType>::nOldTimes; \
using OldTimeField<FieldType>::oldTime; \
using OldTimeField<FieldType>::oldTimeRef;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "OldTimeFieldI.H"
#ifdef NoRepository
#include "OldTimeField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|