ABLATE Source Documentation  0.12.34
ablate::particles::accessors::Accessor< DataType > Class Template Referenceabstract

#include <accessor.hpp>

Public Member Functions

 Accessor (bool cachePointData)
 
Data< DataType > operator[] (const std::string &fieldName)
 
Data< DataType > GetData (const std::string &fieldName)
 
void RegisterCleanupFunction (const std::function< void()> &function)
 
 Accessor (const Accessor &)=delete
 

Protected Member Functions

virtual Data< DataType > CreateData (const std::string &fieldName)=0
 

Detailed Description

template<class DataType>
class ablate::particles::accessors::Accessor< DataType >

Class responsible for computing point data locations for particle integration

Constructor & Destructor Documentation

◆ Accessor()

template<class DataType >
ablate::particles::accessors::Accessor< DataType >::Accessor ( const Accessor< DataType > &  )
delete

prevent copy of this class

Member Function Documentation

◆ CreateData()

template<class DataType >
virtual Data<DataType> ablate::particles::accessors::Accessor< DataType >::CreateData ( const std::string &  fieldName)
protectedpure virtual

◆ GetData()

template<class DataType >
Data<DataType> ablate::particles::accessors::Accessor< DataType >::GetData ( const std::string &  fieldName)
inline

Get the field data for this field

Parameters
fieldName
Returns

◆ operator[]()

template<class DataType >
Data<DataType> ablate::particles::accessors::Accessor< DataType >::operator[] ( const std::string &  fieldName)
inline

Get the field data for this field

Parameters
fieldName
Returns

◆ RegisterCleanupFunction()

template<class DataType >
void ablate::particles::accessors::Accessor< DataType >::RegisterCleanupFunction ( const std::function< void()> &  function)
inline

register a cleanup function

Parameters
function

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