PhyStar  v0.0.0 thu24
smart::OptimalSurfingAgent Class Reference

#include <OptimalSurfingAgent.hpp>

Inheritance diagram for smart::OptimalSurfingAgent:
Collaboration diagram for smart::OptimalSurfingAgent:

Public Member Functions

virtual std::string name ()
 return the name of the agent More...
 
virtual void decideAction (dmdyn::ParticleField< 2 > &pfield, const dmdyn::ParticleModel *pmodel, bool iexplore)
 calculating the optimal navigation direction according to Monthiller et al. (2022) More...
 
virtual void decideAction (dmdyn::ParticleField< 3 > &pfield, const dmdyn::ParticleModel *pmodel, bool iexplore)
 
virtual void initialize (tml::table *config, tml::table *subconfig)
 

Static Public Member Functions

static std::string _name ()
 

Public Attributes

Real tau
 
int N_dim
 
Eigen::Vector2d direction_2d
 
Eigen::Vector3d direction
 

Member Function Documentation

◆ _name()

static std::string smart::OptimalSurfingAgent::_name ( )
inlinestatic
Here is the caller graph for this function:

◆ decideAction() [1/2]

virtual void smart::OptimalSurfingAgent::decideAction ( dmdyn::ParticleField< 2 > &  pfield,
const dmdyn::ParticleModel pmodel,
bool  iexplore 
)
inlinevirtual

calculating the optimal navigation direction according to Monthiller et al. (2022)

Parameters
pfield
pmodel
iexplore

Implements smart::Agent.

References dmdyn::SmartData< N_dim >::action, direction_2d, dmdyn::SmartData< N_dim >::state, and tau.

◆ decideAction() [2/2]

virtual void smart::OptimalSurfingAgent::decideAction ( dmdyn::ParticleField< 3 > &  pfield,
const dmdyn::ParticleModel pmodel,
bool  iexplore 
)
inlinevirtual

◆ initialize()

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

Implements smart::Agent.

References direction, direction_2d, N_dim, and tau.

◆ name()

virtual std::string smart::OptimalSurfingAgent::name ( )
inlinevirtual

return the name of the agent

Returns
std::string

Implements smart::Agent.

References _name().

Here is the call graph for this function:

Member Data Documentation

◆ direction

Eigen::Vector3d smart::OptimalSurfingAgent::direction

◆ direction_2d

Eigen::Vector2d smart::OptimalSurfingAgent::direction_2d

◆ N_dim

int smart::OptimalSurfingAgent::N_dim

◆ tau

Real smart::OptimalSurfingAgent::tau

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