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

a singleton which returns and stores the interface implementations. More...

#include <MamicoInterfaceProvider.h>

Public Member Functions

void setMacroscopicSolverInterface (coupling::interface::MacroscopicSolverInterface< dim > *macroscopicSolverInterface)
 
coupling::interface::MacroscopicSolverInterface< dim > * getMacroscopicSolverInterface ()
 
void setMDSolverInterface (coupling::interface::MDSolverInterface< LinkedCell, dim > *mdSolverInterface)
 
coupling::interface::MDSolverInterface< LinkedCell, dim > * getMDSolverInterface ()
 
void setCouplingCellService (coupling::services::CouplingCellService< dim > *couplingCellService)
 
coupling::services::CouplingCellService< dim > * getCouplingCellService ()
 

Static Public Member Functions

static MamicoInterfaceProvidergetInstance ()
 

Private Member Functions

 MamicoInterfaceProvider ()
 
 ~MamicoInterfaceProvider ()
 

Private Attributes

coupling::interface::MacroscopicSolverInterface< dim > * _macroscopicSolverInterface
 
coupling::interface::MDSolverInterface< LinkedCell, dim > * _mdSolverInterface
 
coupling::services::CouplingCellService< dim > * _couplingCellService
 

Detailed Description

template<class LinkedCell, int dim>
class coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >

a singleton which returns and stores the interface implementations.

This is a singleton which returns and stores the interface implementations. It can be used if there is no other way to share access to a particular interface object between MaMiCo and the MD simulation

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

Constructor & Destructor Documentation

◆ MamicoInterfaceProvider()

template<class LinkedCell, int dim>
coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::MamicoInterfaceProvider ( )
inlineprivate

Private constructor, creation throgh a pointer and set functions

Note
singelton pattern

◆ ~MamicoInterfaceProvider()

template<class LinkedCell, int dim>
coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::~MamicoInterfaceProvider ( )
inlineprivate

Private destructor

Note
singelton pattern

Member Function Documentation

◆ getCouplingCellService()

template<class LinkedCell, int dim>
coupling::services::CouplingCellService< dim > * coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::getCouplingCellService ( )
inline

returns coupling cell service

Returns
_couplingCellService

◆ getInstance()

template<class LinkedCell, int dim>
static MamicoInterfaceProvider & coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::getInstance ( )
inlinestatic

returns the MamicoInterfaceProvider object

◆ getMacroscopicSolverInterface()

template<class LinkedCell, int dim>
coupling::interface::MacroscopicSolverInterface< dim > * coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::getMacroscopicSolverInterface ( )
inline

returns acroscopic solver interface

Returns
_macroscopicSolverInterface

◆ getMDSolverInterface()

template<class LinkedCell, int dim>
coupling::interface::MDSolverInterface< LinkedCell, dim > * coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::getMDSolverInterface ( )
inline

returns MD solver interface

Returns
_mdSolverInterface

◆ setCouplingCellService()

template<class LinkedCell, int dim>
void coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::setCouplingCellService ( coupling::services::CouplingCellService< dim > * couplingCellService)
inline

sets coupling cell service

Returns
couplingCellService

◆ setMacroscopicSolverInterface()

template<class LinkedCell, int dim>
void coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::setMacroscopicSolverInterface ( coupling::interface::MacroscopicSolverInterface< dim > * macroscopicSolverInterface)
inline

sets macroscopic solver interface

Parameters
macroscopicSolverInterface

◆ setMDSolverInterface()

template<class LinkedCell, int dim>
void coupling::interface::MamicoInterfaceProvider< LinkedCell, dim >::setMDSolverInterface ( coupling::interface::MDSolverInterface< LinkedCell, dim > * mdSolverInterface)
inline

sets MD solver interface

Parameters
mdSolverInterface

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