mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ca5b0dcbaa
- expose the names of write and stopAt controls for reuse elsewhere and provide a stopAtControls enum for 'unknown' - track the requested number of sub-cycles (was previously a bool)
154 lines
4.3 KiB
C++
154 lines
4.3 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2012 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::subCycle
|
|
|
|
Description
|
|
Perform a subCycleTime on a field
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef subCycle_H
|
|
#define subCycle_H
|
|
|
|
#include "subCycleTime.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class subCycleField Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class GeometricField>
|
|
class subCycleField
|
|
{
|
|
// Private data
|
|
|
|
//- Reference to the field being sub-cycled
|
|
GeometricField& gf_;
|
|
|
|
//- Reference to the field old-time field being sub-cycled
|
|
// Needed to avoid calls to oldTime() which may cause
|
|
// unexpected updates of the old-time field
|
|
GeometricField& gf0_;
|
|
|
|
//- Copy of the "real" old-time value of the field
|
|
GeometricField gf_0_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct field and number of sub-cycles
|
|
subCycleField(GeometricField& gf)
|
|
:
|
|
gf_(gf),
|
|
gf0_(gf.oldTime()),
|
|
gf_0_(gf0_.name() + "_", gf0_)
|
|
{}
|
|
|
|
|
|
//- Destructor
|
|
~subCycleField()
|
|
{
|
|
// Reset the old-time field
|
|
gf0_ = gf_0_;
|
|
|
|
// Correct the time index of the field to correspond to the global time
|
|
gf_.timeIndex() = gf_.time().timeIndex();
|
|
gf0_.timeIndex() = gf_.time().timeIndex();
|
|
}
|
|
|
|
|
|
//- Correct the time index of the field to correspond to
|
|
// the sub-cycling time.
|
|
//
|
|
// The time index is incremented to protect the old-time value from
|
|
// being updated at the beginning of the time-loop in the case of
|
|
// outer iteration
|
|
void updateTimeIndex()
|
|
{
|
|
gf_.timeIndex() = gf_.time().timeIndex() + 1;
|
|
gf0_.timeIndex() = gf_.time().timeIndex() + 1;
|
|
}
|
|
};
|
|
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class subCycle Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class GeometricField>
|
|
class subCycle
|
|
:
|
|
public subCycleField<GeometricField>,
|
|
public subCycleTime
|
|
{
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
subCycle(const subCycle<GeometricField>&) = delete;
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const subCycle<GeometricField>&) = delete;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct field and number of sub-cycles
|
|
subCycle(GeometricField& gf, const label nCycles)
|
|
:
|
|
subCycleField<GeometricField>(gf),
|
|
subCycleTime(const_cast<Time&>(gf.time()), nCycles)
|
|
{
|
|
// Update the field time index to correspond to the sub-cycle time
|
|
this->updateTimeIndex();
|
|
}
|
|
|
|
|
|
//- Destructor
|
|
// End the subCycleTime, which restores the time state
|
|
~subCycle()
|
|
{
|
|
endSubCycle();
|
|
}
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|