VMlib::WorldGen Class Reference

Класс, опеделяющий текущую решаемую задачу More...

#include <WorldGen.h>

Inheritance diagram for VMlib::WorldGen:

Collaboration diagram for VMlib::WorldGen:

Public Member Functions
VMlib::LogStream &	getInfo () const
	Возврат ссылки на объект LogStream Используется в техничеcких целях для организации вывода
std::ostream &	getInfo (char x) const
	Возврат ссылки на поток вывода информации Необходимо для вывода телеметрической информации, информации об ошибках и т.п.
size_t	getCurrentStep () const
	Возврат константной ссылки на параметры распараллеливания по MPI.
double	getCurrentTime () const
const PassportGen &	getPassportGen () const
bool	isFinished () const
	Функция, возвращающая признак завершения счета в решаемой задаче
	WorldGen (const VMlib::PassportGen &passport_)
	Конструктор
virtual	~WorldGen ()
	Деструктор
virtual void	Step ()=0
	Функция выполнения предварительного шага

Public Attributes
size_t	nVtxBeforeMerging

Protected Attributes
LogStream	info
	Поток для вывода логов и сообщений об ошибках
const PassportGen &	passportGen
	Константная ссылка на паспорт конкретного расчета
std::unique_ptr< TimersGen >	timers
	Сведения о временах выполнения основных операций
size_t	currentStep
	Текущий номер шага в решаемой задаче
double	currentTime
	Текущее время в решаемой задаче

Detailed Description

Класс, опеделяющий текущую решаемую задачу

Author

Марчевский Илья Константинович \Version 1.14

Date

6 марта 2026 г.

Definition at line 56 of file WorldGen.h.

Constructor & Destructor Documentation

WorldGen()

WorldGen::WorldGen

(

const VMlib::PassportGen &

passport_

)

Конструктор

Parameters

[in]

passport_

константная ссылка на паспорт расчета

Definition at line 47 of file WorldGen.cpp.

                                                    :
    passportGen(passport_), currentStep(0), currentTime(0.0)
{ };

~WorldGen()

virtual VMlib::WorldGen::~WorldGen ( )

inlinevirtual

Деструктор

Definition at line 115 of file WorldGen.h.

{};

Member Function Documentation

getCurrentStep()

size_t VMlib::WorldGen::getCurrentStep ( ) const

inline

Возврат константной ссылки на параметры распараллеливания по MPI.

Returns

константную ссылку на параметры распараллеливания по MPI const Parallel& getParallel() const { return parallel; };

Возврат номера текущего временного шага

Returns

номера текущего временного шага

Definition at line 99 of file WorldGen.h.

{ return currentStep; };

Here is the caller graph for this function:

getCurrentTime()

double VMlib::WorldGen::getCurrentTime ( ) const

inline

Definition at line 100 of file WorldGen.h.

{ return currentTime; };

Here is the caller graph for this function:

getInfo() [1/2]

VMlib::LogStream & VMlib::WorldGen::getInfo ( ) const

inline

Возврат ссылки на объект LogStream Используется в техничеcких целях для организации вывода

Returns

ссылку на объект LogStream

Definition at line 82 of file WorldGen.h.

{ return info; };

Here is the caller graph for this function:

getInfo() [2/2]

std::ostream & VMlib::WorldGen::getInfo ( char  x ) const

inline

Возврат ссылки на поток вывода информации Необходимо для вывода телеметрической информации, информации об ошибках и т.п.

Parameters

[in]

x

символ, определяющий стиль вывода сообщения

Returns

ссылку на поток вывода информации

Definition at line 89 of file WorldGen.h.

{ return info(x); };

getPassportGen()

const PassportGen & VMlib::WorldGen::getPassportGen ( ) const

inline

Definition at line 102 of file WorldGen.h.

{ return passportGen; };

Here is the caller graph for this function:

isFinished()

bool WorldGen::isFinished

(

)

const

Функция, возвращающая признак завершения счета в решаемой задаче

true, если задача решена и выполнен признак останова; false если требуется еще выполнять шаги по времени

Definition at line 52 of file WorldGen.cpp.

{
    return (currentTime >= passportGen.timeDiscretizationProperties.timeStop);
}

Step()

virtual void VMlib::WorldGen::Step ( )

pure virtual

Функция выполнения предварительного шага

Основная функция выполнения одного шага по времени

Implemented in VM2D::World2D.

Member Data Documentation

currentStep

size_t VMlib::WorldGen::currentStep

protected

Текущий номер шага в решаемой задаче

Definition at line 69 of file WorldGen.h.

currentTime

double VMlib::WorldGen::currentTime

protected

Текущее время в решаемой задаче

Definition at line 72 of file WorldGen.h.

info

LogStream VMlib::WorldGen::info

mutableprotected

Поток для вывода логов и сообщений об ошибках

Definition at line 60 of file WorldGen.h.

nVtxBeforeMerging

size_t VMlib::WorldGen::nVtxBeforeMerging

Definition at line 76 of file WorldGen.h.

passportGen

const PassportGen& VMlib::WorldGen::passportGen

protected

Константная ссылка на паспорт конкретного расчета

Definition at line 63 of file WorldGen.h.

timers

std::unique_ptr<TimersGen> VMlib::WorldGen::timers

protected

Сведения о временах выполнения основных операций

Definition at line 66 of file WorldGen.h.

---

The documentation for this class was generated from the following files:

• VMlib/WorldGen/WorldGen.h
• VMlib/WorldGen/WorldGen.cpp