highres-cortex 6.0.4
yl::ConstantStepAdvection Class Reference

Forward advection using a constant step size. More...

#include <highres-cortex/advection.hh>

Inheritance diagram for yl::ConstantStepAdvection:
Collaboration diagram for yl::ConstantStepAdvection:

Public Member Functions

 ConstantStepAdvection (const yl::VectorField3d &advection_field, float step)
 
virtual ~ConstantStepAdvection ()
 
void set_step (float step)
 Change the step length.
 
- Public Member Functions inherited from yl::Advection
 Advection (const VectorField3d &advection_field)
 
virtual ~Advection ()
 
template<class TVisitor>
bool visitor_advection (TVisitor &visitor, const Point3df &start_point) const
 Advect a visitor along a vector field.
 
void set_max_iter (unsigned int max_iter)
 Set the maximum number of iterations.
 
void set_verbose (const int verbosity)
 Set the verbosity level (output to stderr)
 

Additional Inherited Members

- Static Public Attributes inherited from yl::Advection
static const unsigned int default_max_iter = 1000
 Default iteration limit.
 

Detailed Description

Forward advection using a constant step size.

The step size can be negative, in which case the advection is done in the opposite direction.

Definition at line 140 of file advection.hh.

Constructor & Destructor Documentation

◆ ConstantStepAdvection()

yl::ConstantStepAdvection::ConstantStepAdvection ( const yl::VectorField3d & advection_field,
float step )

◆ ~ConstantStepAdvection()

virtual yl::ConstantStepAdvection::~ConstantStepAdvection ( )
inlinevirtual

Definition at line 144 of file advection.hh.

Member Function Documentation

◆ set_step()

void yl::ConstantStepAdvection::set_step ( float step)
inline

Change the step length.

Definition at line 147 of file advection.hh.


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