#include <Advection.h>

Public Types
enum class	ADVECTION_METHOD { EULER = 0 , RK4 = 1 }

Public Member Functions
	Advection ()

int	AdvectSteps (Field *velocityField, double deltaT, size_t maxSteps, bool fixedStepSize, ADVECTION_METHOD method=ADVECTION_METHOD::RK4)

int	AdvectTillTime (Field *velocityField, double startT, double deltaT, double targetT, bool fixedStepSize, ADVECTION_METHOD method=ADVECTION_METHOD::RK4)

int	CalculateParticleValues (Field *scalarField, bool skipNonZero)

int	CalculateParticleIntegratedValues (Field *scalarField, const bool skipNonZero, const float distScale=1.f, const std::vector< double > &integrateWithinVolumeMin={-FLT_MAX, -FLT_MAX, -FLT_MAX}, const std::vector< double > &integrateWithinVolumeMax={FLT_MAX, FLT_MAX, FLT_MAX})

void	SetAllStreamValuesToFinalValue (int realNSamples)

int	CalculateParticleProperties (Field *scalarField)

void	CalculateParticleHistogram (std::vector< double > &bounds, std::vector< long > &bins)

void	ResetParticleValues ()

void	ClearParticleProperties ()

void	RemoveParticleProperty (const std::string &)

void	UseSeedParticles (const std::vector< Particle > &seeds)

size_t	GetNumberOfStreams () const

const std::vector< Particle > &	GetStreamAt (size_t i) const

size_t	GetMaxNumOfPart () const

int	CheckReady () const

void	SetXPeriodicity (bool, float min, float max)

void	SetYPeriodicity (bool, float min, float max)

void	SetZPeriodicity (bool, float min, float max)

auto	GetValueVarName () const -> std::string

auto	GetPropertyVarNames () const -> std::vector< std::string >

Detailed Description

Definition at line 16 of file Advection.h.

Member Enumeration Documentation

◆ ADVECTION_METHOD

enum class flow::Advection::ADVECTION_METHOD

strong

Enumerator
EULER
RK4

Definition at line 18 of file Advection.h.

Constructor & Destructor Documentation

◆ Advection()

flow::Advection::Advection ( )

Member Function Documentation

◆ AdvectSteps()

int flow::Advection::AdvectSteps	(	Field *	velocityField,
		double	deltaT,
		size_t	maxSteps,
		bool	fixedStepSize,
		ADVECTION_METHOD	method = `ADVECTION_METHOD::RK4`
	)

◆ AdvectTillTime()

int flow::Advection::AdvectTillTime	(	Field *	velocityField,
		double	startT,
		double	deltaT,
		double	targetT,
		bool	fixedStepSize,
		ADVECTION_METHOD	method = `ADVECTION_METHOD::RK4`
	)

◆ CalculateParticleHistogram()

void flow::Advection::CalculateParticleHistogram	(	std::vector< double > &	bounds,
		std::vector< long > &	bins
	)

◆ CalculateParticleIntegratedValues()

int flow::Advection::CalculateParticleIntegratedValues	(	Field *	scalarField,
		const bool	skipNonZero,
		const float	distScale = `1.f`,
		const std::vector< double > &	integrateWithinVolumeMin = `{-FLT_MAX, -FLT_MAX, -FLT_MAX}`,
		const std::vector< double > &	integrateWithinVolumeMax = `{FLT_MAX, FLT_MAX, FLT_MAX}`
	)

◆ CalculateParticleProperties()

int flow::Advection::CalculateParticleProperties ( Field * scalarField )

◆ CalculateParticleValues()

int flow::Advection::CalculateParticleValues	(	Field *	scalarField,
		bool	skipNonZero
	)

◆ CheckReady()

int flow::Advection::CheckReady ( ) const

◆ ClearParticleProperties()

void flow::Advection::ClearParticleProperties ( )

◆ GetMaxNumOfPart()

size_t flow::Advection::GetMaxNumOfPart ( ) const

◆ GetNumberOfStreams()

size_t flow::Advection::GetNumberOfStreams ( ) const

◆ GetPropertyVarNames()

auto flow::Advection::GetPropertyVarNames ( ) const -> std::vector< std::string >

◆ GetStreamAt()

const std::vector< Particle > & flow::Advection::GetStreamAt ( size_t i ) const

◆ GetValueVarName()

auto flow::Advection::GetValueVarName ( ) const -> std::string

◆ RemoveParticleProperty()

void flow::Advection::RemoveParticleProperty ( const std::string & )

◆ ResetParticleValues()

void flow::Advection::ResetParticleValues ( )

◆ SetAllStreamValuesToFinalValue()

void flow::Advection::SetAllStreamValuesToFinalValue ( int realNSamples )

◆ SetXPeriodicity()

void flow::Advection::SetXPeriodicity	(	bool	,
		float	min,
		float	max
	)

◆ SetYPeriodicity()

void flow::Advection::SetYPeriodicity	(	bool	,
		float	min,
		float	max
	)

◆ SetZPeriodicity()

void flow::Advection::SetZPeriodicity	(	bool	,
		float	min,
		float	max
	)

◆ UseSeedParticles()

void flow::Advection::UseSeedParticles ( const std::vector< Particle > & seeds )

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

/Users/pearse/VAPOR/include/vapor/Advection.h

Public Types

Public Member Functions