MercuryBase.h File Reference

#include <iostream>
#include "DPMBase.h"
#include "HGrid.h"

Go to the source code of this file.

Classes
class	MercuryBase
	This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined in the class Grid defined below. More...

Enumerations
enum	HGridMethod { BOTTOMUP , TOPDOWN }
	Enum class that indicates how particles in different levels (cross level checking) of the HGrid are checked for interactions. More...
enum	HGridDistribution { OLDHGRID , LINEAR , EXPONENTIAL , USER }
	Enum that indicates what the ratio of the size of the cells in different levels is. More...

Functions
std::ostream &	operator<< (std::ostream &os, HGridMethod h)
std::istream &	operator>> (std::istream &is, HGridMethod &h)
std::ostream &	operator<< (std::ostream &os, HGridDistribution h)
std::istream &	operator>> (std::istream &is, HGridDistribution &h)

Enumeration Type Documentation

HGridDistribution

enum HGridDistribution

Enum that indicates what the ratio of the size of the cells in different levels is.

The options for the distribution of cell-sizes are:

• OLDHGRID Each cell is twice as big as the one below it, for example (1, 2, 4, 8, ...).
• LINEAR The difference between the cell sizes at each level is the same, for example (1, 2, 3, 4, ...).
• EXPONENTIAL Each cell size is a constant factor c > 1 bigger than the one below it, for example with c = 3, (1, 3, 9, 27, ...).
• USER The cell sizes are defined by the user.

Enumerator
OLDHGRID
LINEAR
EXPONENTIAL
USER

{
    OLDHGRID, LINEAR, EXPONENTIAL, USER
};

HGridMethod

enum HGridMethod

Enum class that indicates how particles in different levels (cross level checking) of the HGrid are checked for interactions.

With this enum class, one can choose how they want to check particles in different levels for interactions, so called cross-level checking BOTTOMUP means that small particles are inserted into the coarser HGrid-level, TOPDOWN means that big particles are inserted into a finer HGrid-level when checking for interactions.

Enumerator
BOTTOMUP
TOPDOWN

{
    BOTTOMUP, TOPDOWN
};

Function Documentation

operator<<() [1/2]

std::ostream& operator<< ( std::ostream &  os, HGridDistribution  h  )

inline

{
    if (h == OLDHGRID)
        return os << "OLDHGRID";
    else if (h == LINEAR)
        return os << "LINEAR";
    else if (h == EXPONENTIAL)
        return os << "EXPONENTIAL";
    else
        return os << "USER";
}

References EXPONENTIAL, LINEAR, and OLDHGRID.

operator<<() [2/2]

std::ostream& operator<< ( std::ostream &  os, HGridMethod  h  )

inline

{
    if (h == BOTTOMUP)
        return os << "BOTTOMUP";
    else
        return os << "TOPDOWN";
}

References BOTTOMUP.

operator>>() [1/2]

std::istream& operator>> ( std::istream &  is, HGridDistribution &  h  )

inline

{
    std::string s;
    is >> s;
    if (s == "OLDHGRID")
        h = OLDHGRID;
    else if (s == "LINEAR")
        h = LINEAR;
    else if (s == "EXPONENTIAL")
        h = EXPONENTIAL;
    else if (s == "USER")
        h = USER;
    else
    {
        logger(ERROR,"HGridDistribution could not be read: %",s);
    }
    return is;
}

References ERROR, EXPONENTIAL, LINEAR, logger, OLDHGRID, s, oomph::Global_string_for_annotation::string(), and USER.

operator>>() [2/2]

std::istream& operator>> ( std::istream &  is, HGridMethod &  h  )

inline

{
    std::string s;
    is >> s;
    if (s == "BOTTOMUP")
        h = BOTTOMUP;
    else if (s == "TOPDOWN")
        h = TOPDOWN;
    else
    {
        logger(ERROR, "HGridMethod could not be read: %", s);
    }
    return is;
}

References BOTTOMUP, ERROR, logger, s, oomph::Global_string_for_annotation::string(), and TOPDOWN.