smart::Sensor Class Reference

#include <Sensor.hpp>

Inheritance diagram for smart::Sensor:

Public Member Functions
virtual int	dim () const =0
	get the dimension of the state (the size of the pfield.state) More...
virtual void	getState (dmdyn::ParticleField< 2 > &pfield, const dmdyn::ParticleModel *pmodel)=0
	calculate state More...
virtual void	getState (dmdyn::ParticleField< 3 > &pfield, const dmdyn::ParticleModel *pmodel)=0
virtual void	initialize (tml::table *config, tml::table *subconfig)=0
	initialize the sensor More...

Member Function Documentation

dim()

virtual int smart::Sensor::dim ( ) const

pure virtual

get the dimension of the state (the size of the pfield.state)

Returns

int dimension

Implemented in smart::FluidVelGradSensor.

getState() [1/2]

virtual void smart::Sensor::getState ( dmdyn::ParticleField< 2 > &  pfield, const dmdyn::ParticleModel *  pmodel  )

pure virtual

calculate state

Parameters

pfield	particle field
pmodel	particle model

Implemented in smart::FluidVelGradSensor.

getState() [2/2]

virtual void smart::Sensor::getState ( dmdyn::ParticleField< 3 > &  pfield, const dmdyn::ParticleModel *  pmodel  )

pure virtual

Implemented in smart::FluidVelGradSensor.

initialize()

virtual void smart::Sensor::initialize ( tml::table *  config, tml::table *  subconfig  )

pure virtual

initialize the sensor

Parameters

config

toml node

Implemented in smart::FluidVelGradSensor.

---

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

• /mnt/e/linuxOS/PhyStar/SmartParticle/Sensor/Sensor.hpp