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ких целях для организации вывода More...
std::ostream &	getInfo (char x) const
	Возврат ссылки на поток вывода информации Необходимо для вывода телеметрической информации, информации об ошибках и т.п. More...
size_t	getCurrentStep () const
	Возврат константной ссылки на параметры распараллеливания по MPI. More...
const PassportGen &	getPassportGen ()
bool	isFinished () const
	Функция, возвращающая признак завершения счета в решаемой задаче More...
	WorldGen (const VMlib::PassportGen &passport_)
	Конструктор More...
virtual	~WorldGen ()
	Деструктор More...
virtual void	Step ()=0
	Функция выполнения предварительного шага More...

Public Attributes
size_t	currentStep
	Текущий номер шага в решаемой задаче More...

Protected Attributes
LogStream	info
	Поток для вывода логов и сообщений об ошибках More...
const PassportGen &	passportGen
	Константная ссылка на паспорт конкретного расчета More...
std::unique_ptr< TimesGen >	timestat
	Сведения о временах выполнения основных операций More...

Detailed Description

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

Author

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

Date

14 января 2024 г.

Definition at line 55 of file WorldGen.h.

Constructor & Destructor Documentation

WorldGen::WorldGen

(

const VMlib::PassportGen &

passport_

)

Конструктор

Parameters

[in]

passport_

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

Definition at line 44 of file WorldGen.cpp.

                                                    :
    passportGen(passport_)
{ };

Here is the caller graph for this function:

virtual VMlib::WorldGen::~WorldGen ( )

inlinevirtual

Деструктор

Definition at line 106 of file WorldGen.h.

{};

Here is the call graph for this function:

Member Function Documentation

size_t VMlib::WorldGen::getCurrentStep ( ) const

inline

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

Returns

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

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

Definition at line 91 of file WorldGen.h.

{ return currentStep; };

Here is the caller graph for this function:

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

inline

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

Returns

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

Definition at line 74 of file WorldGen.h.

{ return info; };

Here is the caller graph for this function:

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

inline

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

Parameters

[in]

x

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

Returns

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

Definition at line 81 of file WorldGen.h.

{ return info(x); };

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

inline

Definition at line 93 of file WorldGen.h.

{ return passportGen; };

Here is the call graph for this function:

bool WorldGen::isFinished

(

)

const

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

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

Definition at line 49 of file WorldGen.cpp.

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

virtual void VMlib::WorldGen::Step ( )

pure virtual

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

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

Implemented in VM2D::World2D.

Here is the caller graph for this function:

Member Data Documentation

size_t VMlib::WorldGen::currentStep

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

Definition at line 69 of file WorldGen.h.

LogStream VMlib::WorldGen::info

mutableprotected

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

Definition at line 59 of file WorldGen.h.

const PassportGen& VMlib::WorldGen::passportGen

protected

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

Definition at line 62 of file WorldGen.h.

std::unique_ptr<TimesGen> VMlib::WorldGen::timestat

protected

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

Definition at line 65 of file WorldGen.h.

---

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

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