VMlib Namespace Reference

Classes
struct	GeomPoint
class	LogStream
	Класс, определяющий работу с потоком логов More...
class	nummatrix
	Шаблонный класс, определяющий матрицу фиксированного размера Фактически представляет собой массив, для которого определено большое количество различных операций. Для доступа к элементам матрицы используется оператор [][] Оператор[] имитирует возврат ссылки/константной ссылки на numvector. More...
class	numvector
	Шаблонный класс, определяющий вектор фиксированной длины Фактически представляет собой массив, для которого определено большое количество различных операций. Для доступа к элементам массива используется оператор []. More...
class	PairInt
	Класс, опеделяющий пару целых чисел More...
class	Parallel
	Класс, опеделяющий параметры исполнения задачи в параллельном MPI-режиме More...
struct	parProp
	Стрктура, содержащая параметры исполнения задачи в параллельном MPI-режиме More...
class	PassportGen
	Абстрактный класс, опеделяющий паспорт задачи More...
class	Point2D
	Класс, опеделяющий двумерный вектор More...
class	Preprocessor
	Класс, позволяющий выполнять предварительную обработку файлов More...
class	Queue
	Класс, опеделяющий список решаемых задач и очередь их прохождения More...
class	StreamParser
	Класс, позволяющий выполнять разбор файлов и строк с настройками и параметрами More...
class	Task
	Класс, опеделяющий описание каждой задачи в смысле прохождения процесса ее решения More...
struct	TimeDiscretizationProperties
	Структура, задающая параметры процесса интегрирования по времени More...
class	TimesGen
	Класс для сбора статистики времени исполнения основных шагов алгоритма и вывода ее в файл More...
struct	TParticleCode
class	v3D
	Класс, опеделяющий двумерный вектор More...
class	Vortex2D
	Класс, опеделяющий двумерный вихревой элемент More...
class	WorldGen
	Класс, опеделяющий текущую решаемую задачу More...

Typedefs
typedef Vortex2D	Source2D
	Определение типа данных - источника, имеющего ту же структуру, что и вихрь More...

Enumerations
enum	TaskState {   TaskState::waiting = 0, TaskState::starting = 1, TaskState::running = 2, TaskState::finishing = 3,   TaskState::done = 4 }
	Тип-перечисление, опеделяющий состояние задачи в процессе работы программы More...

Functions
std::string	CurrentDataTime ()
	Формирование строки с текущем временем и датой More...
void	PrintLogoToStream (std::ostream &str)
	Передача в поток вывода шапки программы VM2D/VM3D. More...
void	PrintUniversalLogoToStream (std::ostream &str)
	Передача в поток вывода универсальной шапки программы VM2D/VM3D. More...
void	PrintLogoToTextFile (std::ofstream &str, const std::string &fileName, const std::string &descr)
	Формирование заголовка файла программы VM2D/VM3D. More...
void	PrintHeaderToTextFile (std::ofstream &str, const std::string &header)
	Формирование подзаголовка в текстовом файле вывода программы VM2D/VM3D. More...
template<typename T >
std::ostream &	operator<< (std::ostream &_stream, const std::vector< T > &_vec)
	Переопределение оператора "<<" для вывода в поток вектора std::vector. More...
std::ostream &	operator<< (std::ostream &_stream, const std::pair< std::pair< std::string, int >, std::string > &_pair)
	Переопределение оператора "<<" для вывода в поток пары ((строка, целое число), строка) More...
std::ostream &	operator<< (std::ostream &_stream, const std::pair< std::string, int > &_pair)
	Переопределение оператора "<<" для вывода в поток пары (строка, целое число) More...
bool	fileExistTest (std::string &fileName, LogStream &info, const std::list< std::string > &extList={})
	Проверка существования файла More...
std::string	fileNameStep (const std::string &name, int length, size_t number, const std::string &ext)
	Формирование имени файла More...
void	copyFile (const std::string &fileNameFrom, const std::string &fileNameTo)
	Копирование файла More...
void	CreateDirectory (const std::string &dir, const std::string &name)
	Создание каталога More...
template<typename T >
T	sqr (T x)
	Возведение числа в квадрат More...
template<typename T >
double	macos (const T x)
	Усовершенствованный аркосинус More...
template<typename T >
int	sign (T x)
	Усовершенствованный сигнум More...
void	SaveToStream (const Eigen::MatrixXd &matr, std::ostream &str)
	Сохранение матрицы в поток More...
void	SaveToStream (const Eigen::MatrixXcd &matr, std::ostream &str)
	Сохранение комплекснозначной матрицы в поток More...
void	SaveToStream (const Eigen::VectorXd &vec, std::ostream &str)
	Сохранение вектора в поток More...
void	SaveToStream (const std::vector< Point2D > &vec, std::ostream &str)
	Сохранение списка из двумерных векторов (точек) в поток More...
double	M4 (double t)
	Ядро сглаживания (Монагана) More...
void	ModifyE2 (double *ee2, double dst2)
	Модифицирует массив квадратов расстояний до ближайших вихрей из wake. More...
double	Alpha (const Point2D &p, const Point2D &s)
	Вспомогательная функция вычисления угла между векторами More...
double	Lambda (const Point2D &p, const Point2D &s)
	Вспомогательная функция вычисления логарифма отношения норм векторов More...
Point2D	Omega (const Point2D &a, const Point2D &b, const Point2D &c)
	Вспомогательная функция вычисления величины \( (\vec a \cdot \vec b) \cdot \vec c + (\vec a \times \vec b) \times \vec c \). More...
template<typename T >
void	SwapEnd (T &var)
	Вспомогательная функция перестановки байт местами (нужно для сохранения бинарных VTK) More...
double	boundDenom (double r2, double eps2)
	Способ сглаживания скорости вихря (вихрь Рэнкина или вихрь Ламба) More...
template<typename T , typename P , size_t n, size_t m>
auto	operator& (const numvector< P, n > &x, const nummatrix< T, n, m > &A) -> numvector< typename std::remove_const< decltype(x[0]*A.data()[0])>::type, m >
	Умножение вектора на матрицу More...
template<typename T , typename P , size_t n, size_t m>
auto	operator| (const numvector< T, n > &x, const numvector< P, m > &y) -> nummatrix< typename std::remove_const< decltype(x[0]*y[0])>::type, n, m >
	Умножение вектора на вектор внешним образом More...
template<typename T , size_t n, size_t m>
std::ostream &	operator<< (std::ostream &str, const nummatrix< T, n, m > &x)
	Перегрузка оператора "<<" вывода в поток More...
template<typename T , size_t n>
numvector< T, n >	operator* (double c, const numvector< T, n > &x)
	Оператор "*" умножения вектора на число (число слева, вектор справа) More...
template<typename T , typename P , size_t n>
auto	operator* (const P c, const numvector< T, n > &x) -> numvector< typename std::remove_const< decltype(x[0]*c)>::type, n >
	Оператор "*" умножения вектора на число (число слева, вектор справа) More...
template<typename T , typename P , typename R >
void	cross (const numvector< T, 3 > &x, const numvector< P, 3 > &y, numvector< R, 3 > &z)
	Быстрое вычисление векторного произведения More...
template<typename T , typename P , size_t n>
auto	dist2 (const numvector< T, n > &x, const numvector< P, n > &y) -> typename std::remove_const< decltype(x[0]-y[0])>::type
	Вычисление квадрата расстояния между двумя точками More...
template<typename R = double, typename T , typename P , size_t n>
R	dist (const numvector< T, n > &x, const numvector< P, n > &y)
	Вычисление расстояния между двумя точками More...
template<typename T , size_t n>
std::ostream &	operator<< (std::ostream &str, const numvector< T, n > &x)
	Оператор "<<" вывода вектора в поток More...
template<typename T , typename P , typename R , typename S , size_t n>
std::pair< numvector< T, n >, numvector< P, n > > &	operator+= (std::pair< numvector< T, n >, numvector< P, n >> &a, const std::pair< numvector< R, n >, numvector< S, n >> &b)
	Оператор прибавления "+=" для пар векторов More...
template<typename T , typename P , typename R , typename S , size_t n>
auto	operator+ (const std::pair< numvector< T, n >, numvector< P, n >> &a, const std::pair< numvector< R, n >, numvector< S, n >> &b) -> std::pair< numvector< typename std::remove_const< decltype(a.first[0]+b.first[0])>::type, n >, numvector< typename std::remove_const< decltype(a.second[0]+b.second[0])>::type, n >>
	Оператор сложения "+" для пар векторов More...
template<typename T , typename P , typename R , size_t n>
std::pair< numvector< T, n >, numvector< P, n > > &	operator*= (std::pair< numvector< T, n >, numvector< P, n >> &a, R c)
	Оператор домножения "*=" пары векторов на число (пара слева, число справа) More...
template<typename T , typename P , typename R , size_t n>
auto	operator* (R c, const std::pair< numvector< T, n >, numvector< P, n >> &a) -> std::pair< numvector< typename std::remove_const< decltype(c *a.first[0])>::type, n >, numvector< typename std::remove_const< decltype(c *a.second[0])>::type, n >>
	Оператор умножения "*" числа на пару векторов (число слева, пара справа) More...
template<typename T , typename P , typename R , size_t n>
auto	operator* (const std::pair< numvector< T, n >, numvector< P, n >> &a, R c) -> std::pair< numvector< typename std::remove_const< decltype(a.first[0]*c)>::type, n >, numvector< typename std::remove_const< decltype(a.second[0]*c)>::type, n >>
	Оператор умножения "*" пары векторов на число (пара слева, число справа) More...
template<typename T , typename P , size_t n>
std::ostream &	operator<< (std::ostream &str, const std::pair< numvector< T, n >, numvector< P, n >> &x)
	Оператор "<<" вывода пары векторов в поток More...
template<typename T , typename P , size_t n>
double	cross3 (const numvector< T, n > &x, const numvector< P, n > &y)
	Вычисление третьей компоненты векторного произведения More...
std::pair< PairInt, PairInt > &	operator+= (std::pair< PairInt, PairInt > &a, const std::pair< PairInt, PairInt > &b)
int	is_match (const std::string &line_, const std::string &pattern_)
	Функция сверки строки с шаблоном, который может содержать знаки * и ? More...
v3D	operator* (double c, const v3D &x)
std::pair< v3D, v3D > &	operator+= (std::pair< v3D, v3D > &a, const std::pair< v3D, v3D > &b)
std::pair< v3D, v3D > &	operator*= (std::pair< v3D, v3D > &a, double c)
std::pair< v3D, v3D >	operator* (std::pair< v3D, v3D > &a, double c)

Typedef Documentation

typedef Vortex2D VMlib::Source2D

Определение типа данных - источника, имеющего ту же структуру, что и вихрь

Definition at line 106 of file Vortex2D.h.

Enumeration Type Documentation

enum VMlib::TaskState

strong

Тип-перечисление, опеделяющий состояние задачи в процессе работы программы

Может принимать 5 различных значений:

• waiting (0) — ожидает запуска;
• starting (1) — стартует;
• running (2) — считает;
• finishing (3) — останавливается;
• done (4) — отсчитано;

Author

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

Date

14 января 2024 г.

Enumerator
waiting	задача ожидает запуска
starting	задача стартует
running	задача решается
finishing	задача финиширует
done	задача решена

Definition at line 59 of file Task.h.

    {
        waiting = 0,

        starting = 1,

        running = 2,

        finishing = 3,

        done = 4
    };

Function Documentation

double VMlib::Alpha	(	const Point2D &	p,
		const Point2D &	s
	)

Вспомогательная функция вычисления угла между векторами

Parameters

[in]	p	константная ссылка на первый вектор
[in]	s	константная ссылка на второй вектор

Returns

угол между векторами в диапазоне \( (-\pi; \pi] \)

Definition at line 259 of file defs.cpp.

{
    return atan2(cross3(p, s), p & s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

double VMlib::boundDenom ( double  r2, double  eps2  )

inline

Способ сглаживания скорости вихря (вихрь Рэнкина или вихрь Ламба)

Definition at line 536 of file defs.h.

    {
#ifndef LAMBVORTEX
        return std::max(r2, eps2);
#else
        if (r2 > eps2)
            return std::max(r2, eps2);
        else
            return (r2 < 1e-10) ? 1e-10 : r2 / (1.0 - exp(-6.0*r2 / eps2));
#endif
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void VMlib::copyFile ( const std::string &  fileNameFrom, const std::string &  fileNameTo  )

inline

Копирование файла

Parameters

[in]	fileNameFrom	константная ссылка на имя исходного файла
[in]	fileNameTo	константная ссылка на имя нового файла

Definition at line 388 of file defs.h.

    {
        std::string buf;
        buf.resize(BUFSIZ);

        FILE *in, *out;
        size_t n;

        
#pragma warning (push)
#pragma warning (disable: 4996)
        in = fopen(fileNameFrom.c_str(), "rb");
        out = fopen(fileNameTo.c_str(), "wb");
#pragma warning (pop)

        while ((n = fread((void*)buf.data(), 1, BUFSIZ, in)) != 0) 
        {
            fwrite((void*)buf.data(), 1, n, out);
        }
    }//copyFile

void VMlib::CreateDirectory ( const std::string &  dir, const std::string &  name  )

inline

Создание каталога

Parameters

[in]	dir	константная ссылка на имя текущего каталога (со слешем на конце)
[in]	name	константная ссылка на имя создаваемого подкаталога

Definition at line 414 of file defs.h.

    {
#if defined(_WIN32)
        _mkdir((dir + name).c_str());
#else
        mkdir((dir + name).c_str(), S_IRWXU | S_IRGRP | S_IROTH);
#endif
    }

Here is the caller graph for this function:

template<typename T , typename P , typename R >

void VMlib::cross	(	const numvector< T, 3 > &	x,
		const numvector< P, 3 > &	y,
		numvector< R, 3 > &	z
	)

Быстрое вычисление векторного произведения

Определено только для трехмерных векторов
Оптимизировано за счет отсутствия вызова конструктора, предполагает наличие трех уже созданных векторов

Template Parameters

T	тип данных компонент вектора первого множителя
P	тип данных компонент вектора второго множителя
R	тип данных компонент вектора результата

Parameters

[in]	x	константная ссылка на первый множитель
[in]	y	константная ссылка на второй множитель
[out]	z	ссылка на результат векторного умножения

Definition at line 772 of file numvector.h.

    {
        z = { x[1] * y[2] - x[2] * y[1], x[2] * y[0] - x[0] * y[2], x[0] * y[1] - x[1] * y[0] };
    }//cross(...)

template<typename T , typename P , size_t n>

double VMlib::cross3	(	const numvector< T, n > &	x,
		const numvector< P, n > &	y
	)

Вычисление третьей компоненты векторного произведения

Определено для векторов любой размерности, используются только первые 2 компоненты исходных векторов

Template Parameters

T	тип данных компонент вектора - первого множителя
P	тип данных компонент вектора - второго множителя
n	размерность исходных векторов

Parameters

[in]	x	константная ссылка на первый множитель
[in]	y	константная ссылка на второй множитель

Returns

третья компонента вектороного произведения

Definition at line 1064 of file numvector.h.

    {
        //deprecate: use numvector.operator^ instead of cross3(numvector<>,numvector<>)

        return (x[0] * y[1] - x[1] * y[0]);
    }//cross3(...)

Here is the call graph for this function:

Here is the caller graph for this function:

std::string VMlib::CurrentDataTime

(

)

Формирование строки с текущем временем и датой

Returns

Возвращает строку с текущей датой и временем в формате XX Month 20XX at XX:XX:XX

Definition at line 44 of file defs.cpp.

{
    std::time_t t = std::time(nullptr);

#pragma warning(push)
#pragma warning(disable : 4996) //_CRT_SECURE_NO_WARNINGS
    std::tm tm = *std::localtime(&t);
#pragma warning(pop)

    std::stringstream dateTimeStringStream;
    //dateTimeStringStream << "| This file was created automatically " << std::put_time(&tm, "%d %B %Y") << " at " << std::put_time(&tm, "%H:%M:%S");

    std::stringstream st_day, st_hour, st_min, st_sec;
    if (tm.tm_mday < 10)
        st_day << "0" << tm.tm_mday;
    else
        st_day << tm.tm_mday;

    if (tm.tm_hour < 10)
        st_hour << "0" << tm.tm_hour;
    else
        st_hour << tm.tm_hour;

    if (tm.tm_min < 10)
        st_min << "0" << tm.tm_min;
    else
        st_min << tm.tm_min;

    if (tm.tm_sec < 10)
        st_sec << "0" << tm.tm_sec;
    else
        st_sec << tm.tm_sec;

    dateTimeStringStream \
        << st_day.str() << " " << Months[tm.tm_mon] << " " << 1900 + tm.tm_year \
        << " at " \
        << st_hour.str() << ":" << st_min.str() << ":" << st_sec.str();

    //std::string dateTimeString;
    //dateTimeStringStream >> dateTimeString;

    return dateTimeStringStream.str();
}

Here is the caller graph for this function:

template<typename R = double, typename T , typename P , size_t n>

R VMlib::dist	(	const numvector< T, n > &	x,
		const numvector< P, n > &	y
	)

Вычисление расстояния между двумя точками

Template Parameters

T	тип данных компонент радиус-вектора первой точки
P	тип данных компонент радиус-вектора второй точки
R	тип данных результата (по умолчанию double)

Parameters

[in]	x	константная ссылка на радиус-вектор первой точки
[in]	y	константная ссылка на радиус-вектор второй точки

Returns

расстояние между точками

Definition at line 804 of file numvector.h.

    {
        numvector<R, n> p = x - y;
        return sqrt(p&p);
    }//dist(...)

Here is the caller graph for this function:

template<typename T , typename P , size_t n>

auto VMlib::dist2	(	const numvector< T, n > &	x,
		const numvector< P, n > &	y
	)		-> typename std::remove_const<decltype(x[0] - y[0])>::type

Вычисление квадрата расстояния между двумя точками

Template Parameters

T	тип данных компонент первого радиус-вектора
P	тип данных компонент второго радиус-вектора
n	размерность векторов

Parameters

[in]	x	константная ссылка на радиус-вектор первой точки
[in]	y	константная ссылка на радиус-вектор второй точки

Returns

квадрат расстояния между точками

Definition at line 788 of file numvector.h.

    {
        numvector<typename std::remove_const<decltype(x[0] - y[0])>::type, n> p = x - y;
        return p.length2();
    }//dist2(...)

Here is the call graph for this function:

Here is the caller graph for this function:

bool VMlib::fileExistTest ( std::string &  fileName, LogStream &  info, const std::list< std::string > &  extList = {}  )

inline

Проверка существования файла

Parameters

[in,out]	fileName	ссылка на имя проверяемого файла, заменяется на имя + то из расширений, с которым файл присутствует
[in,out]	info	ссылка на поток вывода логов/ошибок
[in]	extList	константная ссылка на список проверяемых расширений

Returns

true, если файл существует; false если файл отсутствует

Definition at line 324 of file defs.h.

                                                                                                         {})
    {
        std::list<std::string> fullExtList(extList);
        fullExtList.insert(fullExtList.begin(), "");

        for (const auto& ext : fullExtList)
        {
            std::string newFileName = ((ext == "") ? fileName : (fileName + "." + ext));
            std::ifstream f(newFileName.c_str());
            if (f.good())
            {
                f.close();
                f.clear();

                info('i') << "file " << newFileName << " is found" << std::endl;
                fileName = newFileName;
                return true;
            }
        }

        info('e') << "file " << fileName << " is not found" << std::endl;
        exit(-1);
        return false;
    }

Here is the caller graph for this function:

std::string VMlib::fileNameStep ( const std::string &  name, int  length, size_t  number, const std::string &  ext  )

inline

Формирование имени файла

Parameters

[in]	name	константная ссылка на префикс имени файла
[in]	length	количество знаков под номер
[in]	number	номер для имени файла
[in]	ext	константная ссылка на раширение (дописывается, если непустое)

Returns

строку — имя текстового файла

Definition at line 357 of file defs.h.

    {
        std::string fname(name);

        size_t dec = 1;

        for (int i = 1; i < length; ++i)
        {
            dec *= 10;
            if (number < dec)
                fname += "0";
        }

        std::ostringstream ss;
        ss << number;
        fname += ss.str();
        
        if (ext.size() > 0)
        {
            fname += ".";
            fname += ext;
        }

        return fname;
    }

Here is the caller graph for this function:

int VMlib::is_match ( const std::string &  line_, const std::string &  pattern_  )

inline

Функция сверки строки с шаблоном, который может содержать знаки * и ?

Parameters

[in]	line_	константная ссылка на проверяемую строку
[in]	pattern_	константная ссылка на строку-шаблон, с которой производится сверка rerurn признак соответствия строки шаблону

Definition at line 57 of file StreamParser.h.

    {

        const auto lineCStr = line_.c_str();
        const auto patternCStr = pattern_.c_str();

        const char* line = &(lineCStr[0]);
        const char* pattern = &(patternCStr[0]);

        // returns 1 (true) if there is a match
        // returns 0 if the pattern is not whitin the line
        int wildcard = 0;

        const char* last_pattern_start = 0;
        const char* last_line_start = 0;
        do
        {
            if (*pattern == *line)
            {
                if (wildcard == 1)
                    last_line_start = line + 1;

                line++;
                pattern++;
                wildcard = 0;
            }
            else if (*pattern == '?')
            {
                if (*(line) == '\0') // the line is ended but char was expected
                    return 0;
                if (wildcard == 1)
                    last_line_start = line + 1;
                line++;
                pattern++;
                wildcard = 0;
            }
            else if (*pattern == '*')
            {
                if (*(pattern + 1) == '\0')             
                    return 1;               

                last_pattern_start = pattern;
                //last_line_start = line + 1;
                wildcard = 1;

                pattern++;
            }
            else if (wildcard)
            {
                if (*line == *pattern)
                {
                    wildcard = 0;
                    line++;
                    pattern++;
                    last_line_start = line + 1;
                }
                else                
                    line++;             
            }
            else
            {
                if ((*pattern) == '\0' && (*line) == '\0')  // end of mask
                    return 1; // if the line also ends here then the pattern match
                else
                {
                    if (last_pattern_start != 0) // try to restart the mask on the rest
                    {
                        pattern = last_pattern_start;
                        line = last_line_start;
                        last_line_start = 0;
                    }
                    else                    
                        return 0;                   
                }
            }

        } while (*line);

        if (*pattern == '\0')
            return 1;
        else
            return 0;
    };

Here is the caller graph for this function:

double VMlib::Lambda	(	const Point2D &	p,
		const Point2D &	s
	)

Вспомогательная функция вычисления логарифма отношения норм векторов

Parameters

[in]	p	константная ссылка на первый вектор
[in]	s	константная ссылка на второй вектор

Returns

логарифм отношения норм векторов

Definition at line 265 of file defs.cpp.

{
    return 0.5*log((s & s) / (p & p));
}

Here is the caller graph for this function:

double VMlib::M4

(

double

t

)

Ядро сглаживания (Монагана)

Parameters

[in]

t

аргумент ядра

Returns

Значение ядра сглаживания в конкретной точке

Definition at line 224 of file defs.cpp.

{
    double t2 = t*t;
    double mt = t > 0 ? t : -t;

    return (mt > 2.0) ? 0.0 : \
        (mt > 1.0) ? 0.5*sqr(2.0 - mt)*(1.0 - mt) : 1.0 - 2.5*t2 + 1.5*t2*mt;
}//M4(...)

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

double VMlib::macos ( const T  x )

inline

Усовершенствованный аркосинус

Template Parameters

T	тип данных

Parameters

[in]

x

аргумент

Returns

аркосинус аргумента, если |x|<1, или 0, или Pi,

Definition at line 439 of file defs.h.

    {
        double res = abs(x) > 1.0 ? 0.5*PI*(1 - sign(x)) : acos(x);
        return res;
    }

Here is the call graph for this function:

void VMlib::ModifyE2 ( double *  ee2, double  dst2  )

inline

Модифицирует массив квадратов расстояний до ближайших вихрей из wake.

Parameters

[out]	ee2	массив расстояний до трех ближайших вихрей
[in]	dst2	новое расстояние (заменит одно из расстояний в ee2, если меньше)

Definition at line 233 of file defs.cpp.

{
    if (dst2 > 0)
    {
        if (dst2 < ee2[0])
        {
            ee2[2] = ee2[1];
            ee2[1] = ee2[0];
            ee2[0] = dst2;
        }//if (dist2<ee2[0])
        else
        {
            if (dst2 < ee2[1])
            {
                ee2[2] = ee2[1];
                ee2[1] = dst2;
            }// if (dist2<ee2[1])
            else
                if (dst2 < ee2[2])
                    ee2[2] = dst2;
        }//else
    }//if (dst2>0)
}//ModifyE2(...)

Here is the caller graph for this function:

Point2D VMlib::Omega	(	const Point2D &	a,
		const Point2D &	b,
		const Point2D &	c
	)

Вспомогательная функция вычисления величины \( (\vec a \cdot \vec b) \cdot \vec c + (\vec a \times \vec b) \times \vec c \).

Для оптимизации все векторы считаются двумерными

Parameters

[in]	a	константная ссылка на первый вектор
[in]	b	константная ссылка на второй вектор
[in]	c	константная ссылка на третий вектор

Returns

логарифм отношения норм векторов

Definition at line 271 of file defs.cpp.

{
    return (a & b) * c + (Point2D({ -c[1], c[0] }))*cross3(a, b);
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T , typename P , size_t n, size_t m>

auto VMlib::operator&	(	const numvector< P, n > &	x,
		const nummatrix< T, n, m > &	A
	)		-> numvector<typename std::remove_const<decltype(x[0] * A.data()[0])>::type, m>

Умножение вектора на матрицу

Template Parameters

T	тип данных матрицы
P	тип данных вектора
n	длина вектора и число строк матрицы
m	число столбцов матрицы

Parameters

[in]	A	константная ссылка на матрицу
[in]	x	константная ссылка на вектор

Returns

вектор — результат умножения матрицы на вектор

Definition at line 528 of file nummatrix.h.

    {
        numvector<typename std::remove_const<decltype(x[0] * A.data()[0])>::type, m> res;
        for (size_t i = 0; i < m; ++i)
        {
            res[i] = 0;
            for (size_t j = 0; j < n; ++j)
                res[i] += x[j] * A[j][i];
        }
        return res;
    }//operator&(...)

v3D VMlib::operator* ( double  c, const v3D &  x  )

inline

Todo:

Исследовать целесообразность наличия явной перегрузки оператора умножения

Definition at line 109 of file v3D.h.

    {
        v3D res(x);
        for (size_t i = 0; i < 3; ++i)
            res[i] *= c;
        return res;
    }//operator*(...)

std::pair<v3D, v3D> VMlib::operator* ( std::pair< v3D, v3D > &  a, double  c  )

inline

Definition at line 132 of file v3D.h.

    {       
        return {a.first * c, a.second * c};
    }//operator+=(...)

template<typename T , size_t n>

numvector<T, n> VMlib::operator*	(	double	c,
		const numvector< T, n > &	x
	)

Оператор "*" умножения вектора на число (число слева, вектор справа)

Template Parameters

T	тип данных компонент вектора и множителя
n	длина вектора

Parameters

[in]	c	числовой множитель
[in]	x	константная ссылка на умножаемый вектор

Returns

результат умножения вектора на число, приведенный к соответствующему типу

Definition at line 732 of file numvector.h.

    {
        numvector<T, n> res(x);
        for (size_t i = 0; i < n; ++i)
            res[i] *= c;
        return res;
    }//operator*(...)

template<typename T , typename P , size_t n>

auto VMlib::operator*	(	const P	c,
		const numvector< T, n > &	x
	)		-> numvector<typename std::remove_const<decltype(x[0] * c)>::type, n>

Оператор "*" умножения вектора на число (число слева, вектор справа)

Template Parameters

T	тип данных компонент вектора
P	тип данных числового множителя
n	длина вектора

Parameters

[in]	c	числовой множитель
[in]	x	константная ссылка на умножаемый вектор

Returns

результат умножения вектора на число, приведенный к соответствующему типу

Definition at line 750 of file numvector.h.

    {
        numvector<typename std::remove_const<decltype(x[0] * c)>::type, n> res;
        for (size_t i = 0; i < n; ++i)
            res[i] = x[i] * c;
        return res;
    }//operator*(...)

template<typename T , typename P , typename R , size_t n>

auto VMlib::operator* ( R  c, const std::pair< numvector< T, n >, numvector< P, n >> &  a  ) -> std::pair<numvector<typename std::remove_const<decltype(c * a.first[0])>::type, n>, numvector<typename std::remove_const<decltype(c * a.second[0])>::type, n >>

inline

Оператор умножения "*" числа на пару векторов (число слева, пара справа)

tparam T тип данных вектора - первого компонента в паре tparam P тип данных вектора - второго компонента в паре tparam R тип данных числового множителя tparam n длина векторов - компонентов пары param[in] c числовой множитель param[in] a константная ссылка на пару return пару, получаемую при покомпонентном умножении пары на число, приведенную к нужному типу

Definition at line 905 of file numvector.h.

    {
        std::pair<numvector<typename std::remove_const<decltype(c * a.first[0])>::type, n>, numvector<typename std::remove_const<decltype(c * a.second[0])>::type, n >> res;
        res.first = c * a.first;
        res.second = c * a.second;
        return res;
    }//operator*(...)

template<typename T , typename P , typename R , size_t n>

auto VMlib::operator* ( const std::pair< numvector< T, n >, numvector< P, n >> &  a, R  c  ) -> std::pair<numvector<typename std::remove_const<decltype(a.first[0] * c)>::type, n>, numvector<typename std::remove_const<decltype(a.second[0] * c)>::type, n >>

inline

Оператор умножения "*" пары векторов на число (пара слева, число справа)

tparam T тип данных вектора - первого компонента в паре tparam P тип данных вектора - второго компонента в паре tparam R тип данных числового множителя tparam n длина векторов - компонентов пары param[in] c числовой множитель param[in] a константная ссылка на пару return пару, получаемую при покомпонентном умножении пары на число, приведенную к нужному типу

Definition at line 925 of file numvector.h.

    {
        return c * a;
    }//operator*(...)

std::pair<v3D, v3D>& VMlib::operator*= ( std::pair< v3D, v3D > &  a, double  c  )

inline

Definition at line 125 of file v3D.h.

    {
        a.first *= c;
        a.second *= c;
        return a;
    }//operator+=(...)

template<typename T , typename P , typename R , size_t n>

std::pair<numvector<T, n>, numvector<P, n> >& VMlib::operator*= ( std::pair< numvector< T, n >, numvector< P, n >> &  a, R  c  )

inline

Оператор домножения "*=" пары векторов на число (пара слева, число справа)

tparam T тип данных вектора - первого компонента в паре tparam P тип данных вектора - второго компонента в паре tparam R тип данных числового множителя tparam n длина векторов - компонентов пары param[in] a ссылка на пару param[in] c числовой множитель return ссылка на пару после ее покомпонентного домножения на число

Definition at line 887 of file numvector.h.

    {
        a.first *= c;
        a.second *= c;
        return a;
    }//operator*=(...)

template<typename T , typename P , typename R , typename S , size_t n>

auto VMlib::operator+ ( const std::pair< numvector< T, n >, numvector< P, n >> &  a, const std::pair< numvector< R, n >, numvector< S, n >> &  b  ) -> std::pair<numvector<typename std::remove_const<decltype(a.first[0] + b.first[0])>::type, n>, numvector<typename std::remove_const<decltype(a.second[0] + b.second[0])>::type, n >>

inline

Оператор сложения "+" для пар векторов

tparam T тип данных вектора - первого компонента в левой паре tparam P тип данных вектора - второго компонента в левой паре tparam R тип данных вектора - первого компонента в правой паре tparam S тип данных вектора - второго компонента в правой паре tparam n длина векторов - компонентов обеих пар param[in] a константная ссылка на левую пару param[in] b константная ссылка на правую пару return пару, получаемую при покомпонентном суммировании левой и правой пар, приведенную к нужному типу

Definition at line 867 of file numvector.h.

    {
        std::pair<numvector<typename std::remove_const<decltype(a.first[0] + b.first[0])>::type, n>, numvector<typename std::remove_const<decltype(a.second[0] + b.second[0])>::type, n >> res;
        res.first = a.first + b.first;
        res.second = a.second + b.second;
        return res;
    }//operator+(...)

std::pair<PairInt, PairInt>& VMlib::operator+= ( std::pair< PairInt, PairInt > &  a, const std::pair< PairInt, PairInt > &  b  )

inline

Definition at line 103 of file PairInt.h.

    {
        a.first += b.first;
        a.second += b.second;
        return a;
    }//operator+=(...)

std::pair<v3D, v3D>& VMlib::operator+= ( std::pair< v3D, v3D > &  a, const std::pair< v3D, v3D > &  b  )

inline

Definition at line 118 of file v3D.h.

    {
        a.first += b.first;
        a.second += b.second;
        return a;
    }//operator+=(...)

template<typename T , typename P , typename R , typename S , size_t n>

std::pair<numvector<T, n>, numvector<P, n> >& VMlib::operator+= ( std::pair< numvector< T, n >, numvector< P, n >> &  a, const std::pair< numvector< R, n >, numvector< S, n >> &  b  )

inline

Оператор прибавления "+=" для пар векторов

tparam T тип данных вектора - первого компонента в паре tparam P тип данных вектора - второго компонента в паре tparam R тип данных вектора - первого компонента в прибавляемой паре tparam S тип данных вектора - второго компонента в прибавляемой паре tparam n длина векторов - компонентов обеих пар param[in] a ссылка на первую пару param[in] b константная ссылка на прибавляемую пару return ссылку на первую пару после прибавления к ней второй пары

Definition at line 848 of file numvector.h.

    {
        a.first += b.first;
        a.second += b.second;
        return a;
    }//operator+=(...)

template<typename T >

std::ostream& VMlib::operator<<	(	std::ostream &	_stream,
		const std::vector< T > &	_vec
	)

Переопределение оператора "<<" для вывода в поток вектора std::vector.

Компоненты вектора выводятся в фигурных скобках с разделителем ";"

Template Parameters

T	тип элементов в векторе

Parameters

[in,out]	_stream	ссылка на поток для вывода
[in]	_vec	константная ссылка на выводимый вектор

Returns

ссылка на поток

Definition at line 274 of file defs.h.

    {
        size_t n = _vec.size();
        _stream << "{ ";
        if (n > 0)
        {
            for (size_t j = 0; j < n - 1; ++j)
                _stream << _vec[j] << ", ";
            _stream << _vec[n - 1];
        }
        _stream << " }";
        return _stream;
    }//operator<<(...)

std::ostream& VMlib::operator<< ( std::ostream &  _stream, const std::pair< std::pair< std::string, int >, std::string > &  _pair  )

inline

Переопределение оператора "<<" для вывода в поток пары ((строка, целое число), строка)

Компоненты пары выводятся в скобках с разделителем ","

Parameters

[in,out]	_stream	ссылка на поток для вывода
[in]	_pair	константная ссылка на выводимую пару

Returns

ссылка на поток

Definition at line 296 of file defs.h.

    {
        _stream << "( ( " << _pair.first.first << ", " << _pair.first.second << " ), " << _pair.second << " )"; 
        return _stream;
    }//operator<<(...)

std::ostream& VMlib::operator<< ( std::ostream &  _stream, const std::pair< std::string, int > &  _pair  )

inline

Переопределение оператора "<<" для вывода в поток пары (строка, целое число)

Компоненты пары выводятся в скобках с разделителем ","

Parameters

[in,out]	_stream	ссылка на поток для вывода
[in]	_pair	константная ссылка на выводимую пару

Returns

ссылка на поток

Definition at line 310 of file defs.h.

    {
        _stream << "( " << _pair.first << ", " << _pair.second << " )";
        return _stream;
    }//operator<<(...)

template<typename T , size_t n, size_t m>

std::ostream& VMlib::operator<<	(	std::ostream &	str,
		const nummatrix< T, n, m > &	x
	)

Перегрузка оператора "<<" вывода в поток

Выводит в поток вектор, элементы которого записаны в фигурных скобках и разделены запятой с пробелом

Template Parameters

T	тип данных
n	размерность вектора

Parameters

[in,out]	str	ссылка на поток вывода
[in]	x	константная ссылка на вектор

Returns

ссылка на поток вывода

Definition at line 568 of file nummatrix.h.

    {
        str << "{ ";
        for (size_t j = 0; j < n - 1; ++j)
            str << x[j] << ", ";
        str << x[n - 1];
        str << " }";
        return str;
    }//operator<<

template<typename T , size_t n>

std::ostream& VMlib::operator<<	(	std::ostream &	str,
		const numvector< T, n > &	x
	)

Оператор "<<" вывода вектора в поток

Выводит в поток вектор, элементы которого записываются в фигурных скобках и разделены запятой с пробелом

Template Parameters

T	тип данных компонент вектора
n	размерность вектора

Parameters

[in,out]	str	ссылка на поток вывода
[in]	x	константная ссылка на вектор

Returns

ссылку на поток вывода

Definition at line 821 of file numvector.h.

    {
        str << "{ ";
        for (size_t j = 0; j < n - 1; ++j)
            str << x[j] << ", ";
        str << x[n - 1];
        str << " }";
        return str;
    }//operator<<(...)

template<typename T , typename P , size_t n>

std::ostream& VMlib::operator<<	(	std::ostream &	str,
		const std::pair< numvector< T, n >, numvector< P, n >> &	x
	)

Оператор "<<" вывода пары векторов в поток

Выводит в поток векторы из пары, разделяя их запятой с пробелом

Template Parameters

T	тип данных вектора - первого компонента пары
P	тип данных вектора - второго компонента пары
n	размерность векторов

Parameters

[in,out]	str	ссылка на поток вывода
[in]	x	константная ссылка на вектор

Returns

ссылку на поток вывода

Definition at line 943 of file numvector.h.

    {
        str << "{ " << x.first << ", " << x.second << " }";
        return str;
    }//operator<<

template<typename T , typename P , size_t n, size_t m>

auto VMlib::operator| ( const numvector< T, n > &  x, const numvector< P, m > &  y  ) -> nummatrix<typename std::remove_const<decltype(x[0] * y[0])>::type, n, m>

inline

Умножение вектора на вектор внешним образом

Definition at line 544 of file nummatrix.h.

    {
        nummatrix<typename std::remove_const<decltype(x[0] * y[0])>::type, n, m> res;

        for (size_t i = 0; i < n; ++i)
            for (size_t j = 0; j < m; ++j)
                res[i][j] = x[i] * y[j];

        return res;
    }//operator|(...)

void VMlib::PrintHeaderToTextFile	(	std::ofstream &	str,
		const std::string &	header
	)

Формирование подзаголовка в текстовом файле вывода программы VM2D/VM3D.

Печатает в файл вывода программы VM2D/VM3D подзаголовок и подчеркивает его

Parameters

[out]	str	ссылка на файл для вывода, должен быть открыт
[in]	header	константная ссылка на строку с заголовком

Definition at line 172 of file defs.cpp.

{
    str << '\n';
    str << "// " << header << '\n';
    str << "//";
    for (size_t q = 0; q < header.length()+1; ++q)
        str << '-';
}

Here is the caller graph for this function:

void VMlib::PrintLogoToStream

(

std::ostream &

str

)

Передача в поток вывода шапки программы VM2D/VM3D.

Печатает в поток вывода заголовок программы VM2D/VM3D

Parameters

[out]

str

ссылка на поток вывода

Definition at line 105 of file defs.cpp.

{
#ifdef CODE2D
        str <<
            "/*--------------------------------*- VM2D -*-----------------*---------------*\\" << '\n' << \
            "| ##  ## ##   ##  ####  #####   |                            | Version 1.12   |" << '\n' << \
            "| ##  ## ### ### ##  ## ##  ##  |  VM2D: Vortex Method       | 2024/01/14     |" << '\n' << \
            "| ##  ## ## # ##    ##  ##  ##  |  for 2D Flow Simulation    *----------------*" << '\n' << \
            "|  ####  ##   ##   ##   ##  ##  |  Open Source Code                           |" << '\n' << \
            "|   ##   ##   ## ###### #####   |  https://www.github.com/vortexmethods/VM2D  |" << '\n' << \
            "|                                                                             |" << '\n' << \
            "| Copyright (C) 2017-2024 I. Marchevsky, K. Sokol, E. Ryatina, A. Kolganova   |" << '\n' << \
            "*-----------------------------------------------------------------------------*" << '\n';
#endif

#ifdef CODE3D
        str <<
            "/*--------------------------------*- VM3D -*-----------------*---------------*\\" << '\n' << \
            "| ##  ## ##   ##  ####  #####   |                            | Version 1.0    |" << '\n' << \
            "| ##  ## ### ### ##  ## ##  ##  |  VM3D: Vortex Method       | 2019/05/30     |" << '\n' << \
            "| ##  ## ## # ##    ##  ##  ##  |  for 3D Flow Simulation    *----------------*" << '\n' << \
            "|  ####  ##   ## ##  ## ##  ##  |  Open Source Code                           |" << '\n' << \
            "|   ##   ##   ##  ####  #####   |  https://www.github.com/vortexmethods/VM3D  |" << '\n' << \
            "|                                                                             |" << '\n' << \
            "| Copyright (C) 2019 Ilia Marchevsky, Georgy Shcheglov, Sergey Dergachev      |" << '\n' << \
            "*-----------------------------------------------------------------------------*" << '\n';
#endif
}

Here is the caller graph for this function:

void VMlib::PrintLogoToTextFile	(	std::ofstream &	str,
		const std::string &	fileName,
		const std::string &	descr
	)

Формирование заголовка файла программы VM2D/VM3D.

Печатает в шапку файла заголовок программы VM2D/VM3D

Parameters

[out]	str	ссылка на файл для вывода, должен быть открыт
[in]	fileName	константная ссылка на строку с именем файла
[in]	descr	константная ссылка на строку с описанием файла

Definition at line 136 of file defs.cpp.

{
    PrintLogoToStream(str);

    str <<
        "| File name: " << fileName;
    for (size_t q = 0; q < 65 - fileName.length(); ++q)
        str << " ";
    str <<
        "|"  << '\n';

    str <<
        "| Info: " << descr;
    for (size_t q = 0; q < 70 - descr.length(); ++q)
        str << " ";
    str <<
        "|" << '\n';
    
    
    std::string dateTimeString = "| This file was created automatically " + CurrentDataTime();
    //dateTimeStringStream >> dateTimeString;

    str << dateTimeString;  
    for (size_t q = 0; q < 78 - dateTimeString.length(); ++q)
        str << " ";
    str <<
        "|" << '\n';

    str <<
        "\\*---------------------------------------------------------------------------*/" << '\n';
}//PrintLogoToTextFile(...)

Here is the call graph for this function:

Here is the caller graph for this function:

void VMlib::PrintUniversalLogoToStream

(

std::ostream &

str

)

Передача в поток вывода универсальной шапки программы VM2D/VM3D.

Печатает в поток вывода заголовок программы VM2D/VM3D

Parameters

[out]

str

ссылка на поток вывода

Definition at line 89 of file defs.cpp.

{   
    str <<
            "-------------------------------------------------------------------------------" << '\n' << \
            "##\\    ##\\  ##\\      ##\\   ######\\   #######\\         ##\\  ######\\   #######\\  " << '\n' << \
            "## |   ## | ###\\    ### | ##  __##\\  ##  __##\\       ## | ## ___##\\  ##  __##\\ " << '\n' << \
            "## |   ## | ####\\  #### | \\__/  ## | ## |  ## |     ##  /  \\_ / ## | ## |  ## |" << '\n' << \
            "\\##\\  ##  | ##\\##\\## ## |  ######  | ## |  ## |    ##  /    ##### /  ## |  ## |" << '\n' << \
            " \\##\\##  /  ## \\###  ## | ##  ____/  ## |  ## |   ##  /     \\___##\\  ## |  ## |" << '\n' << \
            "  \\###  /   ## |\\#  /## | ## |       ## |  ## |  ##  /    ##\\   ## | ## |  ## |" << '\n' << \
            "   \\#  /    ## | \\_/ ## | ########\\  #######  | ##  /     \\######  | #######  |" << '\n' << \
            "    \\_/     \\__|     \\__| \\________| \\_______/  \\__/       \\______/  \\_______/ " << '\n' << \
            "-------------------------------------------------------------------------------" << '\n';
}

Here is the caller graph for this function:

void VMlib::SaveToStream	(	const Eigen::MatrixXd &	matr,
		std::ostream &	str
	)

Сохранение матрицы в поток

Parameters

[in]	matr	константная ссылка на сохраняемую матрицу
[in,out]	str	ссылка на поток для сохранения

Definition at line 182 of file defs.cpp.

{
    str.precision(16);
    for (int i = 0; i < matr.rows(); ++i)
    {
        for (int j = 0; j < matr.cols(); ++j)
            str << matr(i, j) << " ";
        str << std::endl;
    }
}//SaveToStream(...)

void VMlib::SaveToStream	(	const Eigen::MatrixXcd &	matr,
		std::ostream &	str
	)

Сохранение комплекснозначной матрицы в поток

Parameters

[in]	matr	константная ссылка на сохраняемую комплекснозначную матрицу
[in,out]	str	ссылка на поток для сохранения

Definition at line 195 of file defs.cpp.

{
    for (int i = 0; i < matr.rows(); ++i)
    {
        for (int j = 0; j < matr.cols(); ++j)
            str << matr(i, j) << " ";
        str << std::endl;
    }
}//SaveToStream(...)

void VMlib::SaveToStream	(	const Eigen::VectorXd &	vec,
		std::ostream &	str
	)

Сохранение вектора в поток

Parameters

[in]	vec	константная ссылка на сохраняемый вектор
[in,out]	str	ссылка на поток для сохранения

Definition at line 207 of file defs.cpp.

{
    str.precision(16);
    for (int i = 0; i < vec.size(); ++i)
        str << vec(i) << " ";
}//SaveToStream(...)

void VMlib::SaveToStream	(	const std::vector< Point2D > &	vec,
		std::ostream &	str
	)

Сохранение списка из двумерных векторов (точек) в поток

Parameters

[in]	vec	константная ссылка на сохраняемый список из двумерных векторов (точек)
[in,out]	str	ссылка на поток для сохранения

Definition at line 216 of file defs.cpp.

{
    for (size_t i = 0; i < vec.size(); ++i)
        str << "{ " << vec[i][0] << " " << vec[i][1] << " } ";
}//SaveToStream(...)

Here is the caller graph for this function:

template<typename T >

int VMlib::sign

(

T

x

)

Усовершенствованный сигнум

Template Parameters

T	тип данных

Parameters

[in]

x

аргумент

Returns

знак числа в обычном математическом смысле,

Definition at line 452 of file defs.h.

    {
        double dx = (double)x;
        if (dx > 0) return 1;
        if ( (dx < 0.0) || (dx < -0.0) ) return -1;
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

T VMlib::sqr ( T  x )

inline

Возведение числа в квадрат

Template Parameters

T	тип данных

Parameters

[in]

x

аргумент

Returns

квадрат аргумента \( x^2 \)

Definition at line 430 of file defs.h.

{ return x * x; }

Here is the caller graph for this function:

template<typename T >

void VMlib::SwapEnd

(

T &

var

)

Вспомогательная функция перестановки байт местами (нужно для сохранения бинарных VTK)

Parameters

[in]

var

ссылка на переменную, у которой байты нужно поменять местами

Definition at line 528 of file defs.h.

    {
        char* varArray = reinterpret_cast<char*>(&var);
        for (long i = 0; i < static_cast<long>(sizeof(var) / 2); ++i)
            std::swap(varArray[sizeof(var) - 1 - i], varArray[i]);
    }

Here is the caller graph for this function: