defines the cell type with cell-averaged quantities only (no linked cells). More...

#include <CouplingCell.h>

Inheritance diagram for coupling::datastructures::CouplingCell< dim >:

Collaboration diagram for coupling::datastructures::CouplingCell< dim >:

Public Member Functions
	CouplingCell ()

virtual	~CouplingCell ()

void	setMicroscopicMass (const double &mass)

const double &	getMicroscopicMass () const

void	setMicroscopicMomentum (const tarch::la::Vector< dim, double > &momentum)

const tarch::la::Vector< dim, double > &	getMicroscopicMomentum () const

void	setMacroscopicMass (const double &mass)

const double &	getMacroscopicMass () const

void	setMacroscopicMomentum (const tarch::la::Vector< dim, double > &momentum)

const tarch::la::Vector< dim, double > &	getMacroscopicMomentum () const

const double &	getPotentialEnergy () const

void	setPotentialEnergy (const double &potentialEnergy)

void	addMicroscopicMass (const double &mass)

void	addMicroscopicMomentum (const tarch::la::Vector< dim, double > &momentum)

void	addMacroscopicMass (const double &mass)

void	addMacroscopicMomentum (const tarch::la::Vector< dim, double > &momentum)

void	setCurrentVelocity (const tarch::la::Vector< dim, double > &velocity)

const tarch::la::Vector< dim, double > &	getCurrentVelocity () const

void	setTemperature (const double &temperature)

const double &	getTemperature () const

Public Attributes
double	_microscopicMass

tarch::la::Vector< dim, double >	_microscopicMomentum

double	_macroscopicMass

tarch::la::Vector< dim, double >	_macroscopicMomentum

double	_potentialEnergy

double	_temperature

tarch::la::Vector< dim, double >	_currentVelocity

Detailed Description

template<unsigned int dim>
class coupling::datastructures::CouplingCell< dim >

defines the cell type with cell-averaged quantities only (no linked cells).

describes a quadratic/ cubic coupling cell filled with fluid (no linked cells). Base class for the class coupling::datastructures::CouplingCellWithLinkedCells

Template Parameters

dim	Number of dimensions; it can be 1, 2 or 3

Author: Philipp Neumann

Constructor & Destructor Documentation

◆ CouplingCell()

template<unsigned int dim>

coupling::datastructures::CouplingCell< dim >::CouplingCell ( )

inline

Constructor: initialises the coupling cell with zero values.

◆ ~CouplingCell()

template<unsigned int dim>

virtual coupling::datastructures::CouplingCell< dim >::~CouplingCell ( )

inlinevirtual

Destructor

Member Function Documentation

◆ addMacroscopicMass()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::addMacroscopicMass ( const double & mass )

inline

adds a certain amount to the macroscopic mass

Parameters

mass	Mass to be added to the macroscopic mass

◆ addMacroscopicMomentum()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::addMacroscopicMomentum ( const tarch::la::Vector< dim, double > & momentum )

inline

adds a certain amount to the macroscopic moments

Parameters

momentum Momentum to be added to the macroscopic moments

◆ addMicroscopicMass()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::addMicroscopicMass ( const double & mass )

inline

adds a certain amount to the microscopic mass

Parameters

mass	Mass to be added to the microscopic mass

◆ addMicroscopicMomentum()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::addMicroscopicMomentum ( const tarch::la::Vector< dim, double > & momentum )

inline

adds a certain amount to the microscopic moments

Parameters

momentum Momentum to be added to the microscopic moments

◆ getCurrentVelocity()

template<unsigned int dim>

const tarch::la::Vector< dim, double > & coupling::datastructures::CouplingCell< dim >::getCurrentVelocity ( ) const

inline

returns current velocity (sampled right before any distributeX(...) call)

Returns: _currentVelocity velocity

◆ getMacroscopicMass()

template<unsigned int dim>

const double & coupling::datastructures::CouplingCell< dim >::getMacroscopicMass ( ) const

inline

returns the microscopic mass

Returns: _microscopicMass Mass

◆ getMacroscopicMomentum()

template<unsigned int dim>

const tarch::la::Vector< dim, double > & coupling::datastructures::CouplingCell< dim >::getMacroscopicMomentum ( ) const

inline

returns the microscopic moments

Returns: _microscopicMomentum Momentum

◆ getMicroscopicMass()

template<unsigned int dim>

const double & coupling::datastructures::CouplingCell< dim >::getMicroscopicMass ( ) const

inline

returns the microscopic mass

Returns: _microscopicMass Mass

◆ getMicroscopicMomentum()

template<unsigned int dim>

const tarch::la::Vector< dim, double > & coupling::datastructures::CouplingCell< dim >::getMicroscopicMomentum ( ) const

inline

returns the microscopic moments

Returns: _microscopicMomentum Momentum

◆ getPotentialEnergy()

template<unsigned int dim>

const double & coupling::datastructures::CouplingCell< dim >::getPotentialEnergy ( ) const

inline

returns the mean potential energy over the coupling cell

Returns: _potentialEnergy potential energy

◆ getTemperature()

template<unsigned int dim>

const double & coupling::datastructures::CouplingCell< dim >::getTemperature ( ) const

inline

returns the temperature

Returns: _temperature temperature

◆ setCurrentVelocity()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setCurrentVelocity ( const tarch::la::Vector< dim, double > & velocity )

inline

sets current velocity (sampled right before any distributeX(...) call)

Parameters

velocity velocity

◆ setMacroscopicMass()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setMacroscopicMass ( const double & mass )

inline

sets the microscopic mass

Parameters

mass Mass

◆ setMacroscopicMomentum()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setMacroscopicMomentum ( const tarch::la::Vector< dim, double > & momentum )

inline

sets the microscopic moments

Parameters

momentum Momentum

◆ setMicroscopicMass()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setMicroscopicMass ( const double & mass )

inline

sets the microscopic mass

Parameters

mass Mass

◆ setMicroscopicMomentum()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setMicroscopicMomentum ( const tarch::la::Vector< dim, double > & momentum )

inline

sets the microscopic moments

Parameters

momentum Momentum

◆ setPotentialEnergy()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setPotentialEnergy ( const double & potentialEnergy )

inline

sets the mean potential energy over the coupling cell

Parameters

potentialEnergy potential energy

◆ setTemperature()

template<unsigned int dim>

void coupling::datastructures::CouplingCell< dim >::setTemperature ( const double & temperature )

inline

sets the temperature

Parameters

temperature temperature

Member Data Documentation

◆ _currentVelocity

template<unsigned int dim>

tarch::la::Vector<dim, double> coupling::datastructures::CouplingCell< dim >::_currentVelocity

buffer for current mean velocity in the cell.

◆ _macroscopicMass

template<unsigned int dim>

double coupling::datastructures::CouplingCell< dim >::_macroscopicMass

buffers for macroscopic mass that need to be returned from the microscopic to the macroscopic simulation

◆ _macroscopicMomentum

template<unsigned int dim>

tarch::la::Vector<dim, double> coupling::datastructures::CouplingCell< dim >::_macroscopicMomentum

buffers for macroscopic quantities of momentum that need to be returned from the microscopic to the macroscopic simulation

◆ _microscopicMass

template<unsigned int dim>

double coupling::datastructures::CouplingCell< dim >::_microscopicMass

buffers for macroscopic mass that need to be transferred from the macroscopic to the microscopic simulation

◆ _microscopicMomentum

template<unsigned int dim>

tarch::la::Vector<dim, double> coupling::datastructures::CouplingCell< dim >::_microscopicMomentum

buffers for macroscopic quantities of momentum that need to be transferred from the macroscopic to the microscopic simulation

◆ _potentialEnergy

template<unsigned int dim>

double coupling::datastructures::CouplingCell< dim >::_potentialEnergy

holds the mean potential energy within the coupling cell. This value is needed as a reference potential energy value for the USHER scheme.

◆ _temperature

template<unsigned int dim>

double coupling::datastructures::CouplingCell< dim >::_temperature

temperature within this cell. Needed for the thermostat.

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

coupling/datastructures/CouplingCell.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CouplingCell()

◆ ~CouplingCell()

Member Function Documentation

◆ addMacroscopicMass()

◆ addMacroscopicMomentum()

◆ addMicroscopicMass()

◆ addMicroscopicMomentum()

◆ getCurrentVelocity()

◆ getMacroscopicMass()

◆ getMacroscopicMomentum()

◆ getMicroscopicMass()

◆ getMicroscopicMomentum()

◆ getPotentialEnergy()

◆ getTemperature()

◆ setCurrentVelocity()

◆ setMacroscopicMass()

◆ setMacroscopicMomentum()

◆ setMicroscopicMass()

◆ setMicroscopicMomentum()

◆ setPotentialEnergy()

◆ setTemperature()

Member Data Documentation

◆ _currentVelocity

◆ _macroscopicMass

◆ _macroscopicMomentum

◆ _microscopicMass

◆ _microscopicMomentum

◆ _potentialEnergy

◆ _temperature