MaMiCo 1.2
Loading...
Searching...
No Matches
coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim > Class Template Reference

This class sets a certain temperature over several linked cells. More...

#include <SetTemperatureMapping.h>

Collaboration diagram for coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >:

Public Member Functions

 SetTemperatureMapping (const double &oldTemperature, const double &newTemperature, const tarch::la::Vector< dim, double > &meanVelocity, coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
 
 ~SetTemperatureMapping ()
 
void beginCellIteration ()
 
void endCellIteration ()
 
void handleCell (LinkedCell &cell)
 

Private Member Functions

double getScalingFactor (const double &oldTemperature, const double &newTemperature) const
 

Private Attributes

coupling::interface::MDSolverInterface< LinkedCell, dim > *const _mdSolverInterface
 
const double _factor
 
const tarch::la::Vector< dim, double > _meanVelocity
 

Detailed Description

template<class LinkedCell, unsigned int dim>
class coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >

This class sets a certain temperature over several linked cells.

Template Parameters
LinkedCellcell type
dimNumber of dimensions; it can be 1, 2 or 3
Author
Philipp Neumann

Constructor & Destructor Documentation

◆ SetTemperatureMapping()

template<class LinkedCell, unsigned int dim>
coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >::SetTemperatureMapping ( const double & oldTemperature,
const double & newTemperature,
const tarch::la::Vector< dim, double > & meanVelocity,
coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface )
inline

Constructor: obtains the old temperature over the region of interest. Besides, obtains the new temperature.

Parameters
oldTemperature
newTemperature
meanVelocity
mdSolverInterface

◆ ~SetTemperatureMapping()

template<class LinkedCell, unsigned int dim>
coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >::~SetTemperatureMapping ( )
inline

Destructor

Member Function Documentation

◆ beginCellIteration()

template<class LinkedCell, unsigned int dim>
void coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >::beginCellIteration ( )
inline

empty function

◆ endCellIteration()

template<class LinkedCell, unsigned int dim>
void coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >::endCellIteration ( )
inline

empty function

◆ getScalingFactor()

template<class LinkedCell, unsigned int dim>
double coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >::getScalingFactor ( const double & oldTemperature,
const double & newTemperature ) const
inlineprivate

calculates the scaling factor between the old and new temperatures.

Parameters
oldTemperature
newTemperature
Returns
newTemperature
Remarks
only allow re-scaling if the original temperature was not zero (can happen in empty cells that just became populated)

◆ handleCell()

template<class LinkedCell, unsigned int dim>
void coupling::cellmappings::SetTemperatureMapping< LinkedCell, dim >::handleCell ( LinkedCell & cell)
inline

applies a certain temperature over several linked cells, by changing the velocity (velocity fluctuation).

Parameters
cell

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