WorldGen.h

Go to the documentation of this file.

/*--------------------------------*- VM2D -*-----------------*---------------*\
| ##  ## ##   ##  ####  #####   |                            | Version 1.14   |
| ##  ## ### ### ##  ## ##  ##  |  VM2D: Vortex Method       | 2026/03/06     |
| ##  ## ## # ##    ##  ##  ##  |  for 2D Flow Simulation    *----------------*
|  ####  ##   ##   ##   ##  ##  |  Open Source Code                           |
|   ##   ##   ## ###### #####   |  https://www.github.com/vortexmethods/VM2D  |
|                                                                             |
| Copyright (C) 2017-2026 I. Marchevsky, K. Sokol, E. Ryatina, A. Kolganova   |
*-----------------------------------------------------------------------------*
| File name: WorldGen.h                                                       |
| Info: Source code of VM2D                                                   |
|                                                                             |
| This file is part of VM2D.                                                  |
| VM2D 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.                                         |
|                                                                             |
| VM2D 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 VM2D.  If not, see <http://www.gnu.org/licenses/>.               |
\*---------------------------------------------------------------------------*/
 
 
#ifndef WORLDGEN_H
#define WORLDGEN_H
 
#include "TimesGen.h"
 
namespace VMlib
{
    class PassportGen;
    class TimesGen;
    
    class WorldGen
    {
    protected:
        mutable LogStream info;
 
        const PassportGen& passportGen;
 
        std::unique_ptr<TimersGen> timers;
 
        size_t currentStep;
 
        double currentTime;
 
    public:
 
        size_t nVtxBeforeMerging;
 
        VMlib::LogStream& getInfo() const { return info; };
 
        std::ostream& getInfo(char x) const { return info(x); };
 
 
        size_t getCurrentStep() const { return currentStep; };
        double getCurrentTime() const { return currentTime; };
 
        const PassportGen& getPassportGen() const { return passportGen; };
 
        bool isFinished() const;
 
        WorldGen(const VMlib::PassportGen& passport_);
 
        virtual ~WorldGen() {};
 
        //virtual void ZeroStep() = 0;
 
        virtual void Step() = 0;
    };
 
}//namespace VMlib
 
#endif