coupling::solvers::CouetteSolverInterface< dim > Class Template Reference

interface to couette solver More...

#include <CouetteSolverInterface.h>

Inheritance diagram for coupling::solvers::CouetteSolverInterface< dim >:

Collaboration diagram for coupling::solvers::CouetteSolverInterface< dim >:

Public Member Functions
	CouetteSolverInterface (tarch::la::Vector< dim, unsigned int > globalNumberCouplingCells, unsigned int outerRegion=1)
	a simple constructor
virtual	~CouetteSolverInterface ()
	a dummy destructor
unsigned int	getOuterRegion () override
std::vector< unsigned int >	getRanks (I01 idx) override
	calculates for a coupling cell index, which rank holds it
Public Member Functions inherited from coupling::interface::MacroscopicSolverInterface< dim >
	MacroscopicSolverInterface ()
virtual	~MacroscopicSolverInterface ()
virtual std::vector< unsigned int >	getSourceRanks (I01 idx)
virtual std::vector< unsigned int >	getTargetRanks (I01 idx)

Private Attributes
const unsigned int	_outerRegion
	defines an offset of cells which is considered to be the outer region
const tarch::la::Vector< dim, unsigned int >	_globalNumberCouplingCells
	global number of coupling cells

Detailed Description

template<unsigned int dim>
class coupling::solvers::CouetteSolverInterface< dim >

interface to couette solver

We only receive data from MD in the inner region, and we only send data for the outer region to MD. What "outer" means is specified by the arguments of the interface; moreover, we do not send the ghost layer data from Couette to MD. "inner" refers to "not outer" ;-) By default, the argument outerRegion is set to 1: this yields that only the first non-ghost layer of coupling cells shall be sent to MD, and all other inner coupling cells are received from MD. The couette solver is expected to only run on rank 0.

Author

Philipp Neumann

Template Parameters

dim	refers to the spacial dimension of the simulation, can be 1, 2, or 3

Constructor & Destructor Documentation

CouetteSolverInterface()

template<unsigned int dim>

coupling::solvers::CouetteSolverInterface< dim >::CouetteSolverInterface ( tarch::la::Vector< dim, unsigned int > globalNumberCouplingCells, unsigned int outerRegion = 1 )

inline

a simple constructor

Parameters

globalNumberCouplingCells	the total number of coupling cells
outerRegion	defines, how many cell layers will be sent to the MD solver

Member Function Documentation

getOuterRegion()

template<unsigned int dim>

unsigned int coupling::solvers::CouetteSolverInterface< dim >::getOuterRegion ( )

inlineoverridevirtual

Implements coupling::interface::MacroscopicSolverInterface< dim >.

getRanks()

template<unsigned int dim>

std::vector< unsigned int > coupling::solvers::CouetteSolverInterface< dim >::getRanks ( I01 idx )

inlineoverridevirtual

calculates for a coupling cell index, which rank holds it

Parameters

globalCellIndex

global dimensioned cell index to check for

Returns

returns the rank on which the data is located

Implements coupling::interface::MacroscopicSolverInterface< dim >.

---

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

• coupling/solvers/CouetteSolverInterface.h