Advect a visitor along a vector field. More...

#include <highres-cortex/advection.hh>

Inheritance diagram for yl::Advection:

Classes
class	AbnormalField
	Thrown by move_one_step() to abort the advection. More...

class	Visitor
	Abstract base class for advection visitors. More...

Public Member Functions
	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)

Static Public Attributes
static const unsigned int	default_max_iter = 1000
	Default iteration limit.

Detailed Description

Advect a visitor along a vector field.

Definition at line 48 of file advection.hh.

Constructor & Destructor Documentation

◆ Advection()

yl::Advection::Advection ( const VectorField3d & advection_field )

explicit

◆ ~Advection()

virtual yl::Advection::~Advection ( )

inlinevirtual

Definition at line 52 of file advection.hh.

Member Function Documentation

◆ set_max_iter()

void yl::Advection::set_max_iter ( unsigned int max_iter )

inline

Set the maximum number of iterations.

Definition at line 104 of file advection.hh.

◆ set_verbose()

void yl::Advection::set_verbose ( const int verbosity )

inline

Set the verbosity level (output to stderr)

0: silent (default on instance creation) 1: errors 2: informational messages >=3: debug (needs setting debug_output in advection.tcc)

Definition at line 116 of file advection.hh.

◆ visitor_advection()

template<class TVisitor>

bool yl::Advection::visitor_advection	(	TVisitor &	visitor,
		const Point3df &	start_point ) const

Advect a visitor along a vector field.

visitor object being taken through all the advection path, see Visitor. Can be derived from Visitor, or must have all the same methods.
start_point the start of the advection path

Return values

true	if the advection is stopped by the visitor without encountering any error
false	if the advection stops for another reason

Member Data Documentation

◆ default_max_iter

const unsigned int yl::Advection::default_max_iter = 1000

static

Default iteration limit.

Definition at line 102 of file advection.hh.

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

highres-cortex/advection.hh

Classes

Public Member Functions

Static Public Attributes