130 lines
3.4 KiB
C++
130 lines
3.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd |
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
| Copyright (C) 2011-2014 OpenFOAM Foundation
|
|
-------------------------------------------------------------------------------
|
|
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::subCycleTime
|
|
|
|
Description
|
|
A class for managing sub-cycling times
|
|
|
|
SourceFiles
|
|
subCycleTime.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef subCycleTime_H
|
|
#define subCycleTime_H
|
|
|
|
#include "Time.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class subCycleTime Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class subCycleTime
|
|
{
|
|
// Private data
|
|
|
|
//- Reference to the underlying time
|
|
Time& time_;
|
|
|
|
//- Current index in the sub-cycle
|
|
label index_;
|
|
|
|
//- Total number of cycles in the sub-cycle
|
|
label total_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct referencing the original time and number of sub-cycles
|
|
subCycleTime(Time& runTime, const label nCycle);
|
|
|
|
|
|
//- Destructor
|
|
~subCycleTime();
|
|
|
|
|
|
// Member functions
|
|
|
|
//- Return the current sub-cycle index
|
|
inline label index() const
|
|
{
|
|
return index_;
|
|
}
|
|
|
|
//- Return the total number of sub-cycles
|
|
inline label nSubCycles() const
|
|
{
|
|
return total_;
|
|
}
|
|
|
|
//- True if the sub-cycle is active.
|
|
bool status() const;
|
|
|
|
//- Return true if the number of sub-cycles has been reached
|
|
bool end() const;
|
|
|
|
//- End the sub-cycling and reset the time-state
|
|
void endSubCycle();
|
|
|
|
//- True if looping is active, increments the index.
|
|
// Example usage,
|
|
// \code
|
|
// while (subcycle.loop())
|
|
// {
|
|
// solve;
|
|
// }
|
|
// \endcode
|
|
bool loop();
|
|
|
|
|
|
// Member operators
|
|
|
|
//- Prefix increment
|
|
subCycleTime& operator++();
|
|
|
|
//- Postfix increment, this is identical to the prefix increment
|
|
subCycleTime& operator++(int);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|