TBTK
TBTK::Field< DataType, ArgumentType > Class Template Referenceabstract

#include <Field.h>

Public Member Functions

 Field (bool isCompact=false)
 
virtual DataType operator() (std::initializer_list< ArgumentType > argument) const =0
 
bool getIsCompact () const
 
virtual const std::vector< ArgumentType > & getCoordinates () const
 
virtual ArgumentType getExtent () const
 

Detailed Description

template<typename DataType, typename ArgumentType>
class TBTK::Field< DataType, ArgumentType >

Field.

Constructor & Destructor Documentation

template<typename DataType , typename ArgumentType >
TBTK::Field< DataType, ArgumentType >::Field ( bool  isCompact = false)

Constructor.

Member Function Documentation

template<typename DataType , typename ArgumentType >
const std::vector< ArgumentType > & TBTK::Field< DataType, ArgumentType >::getCoordinates ( ) const
virtual

Get coordinates.

Reimplemented in TBTK::ParallelepipedArrayState.

template<typename DataType , typename ArgumentType >
ArgumentType TBTK::Field< DataType, ArgumentType >::getExtent ( ) const
virtual

Get the radial extent of the field.

Reimplemented in TBTK::ParallelepipedArrayState.

template<typename DataType , typename ArgumentType >
bool TBTK::Field< DataType, ArgumentType >::getIsCompact ( ) const

Returns true if the field is compact. A field that is impact should override getCoordinates() and getExtent().

template<typename DataType, typename ArgumentType>
virtual DataType TBTK::Field< DataType, ArgumentType >::operator() ( std::initializer_list< ArgumentType >  argument) const
pure virtual

Returns the value of the field at the position specified by the argument.

Implemented in TBTK::ParallelepipedArrayState, TBTK::ParametrizedLine, and TBTK::ParametrizedLine3d.


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