LCS::FTLE< T, Dim > Class Template Reference

Class for finite-time Lyapunov exponent (FTLE) fields. More...

#include <ftle.hpp>

Public Member Functions
	FTLE (FlowField< T, Dim > &ff)
T	Get (const unsigned i, const unsigned j) const
void	Calculate ()
Public Member Functions inherited from LCS::Field< T, Dim, 1 >
	Field (unsigned nx, unsigned ny)
auto &	GetAll () const
auto	GetTime () const
void	ReadFromFile (const std::string &file_name)
void	SetAll (Tensor< Vector< T, Size >, Dim > &data)
void	UpdateTime (const T time)
void	WriteToFile (const std::string &file_name) const

Additional Inherited Members
Protected Attributes inherited from LCS::Field< T, Dim, 1 >
const unsigned	nx_
const unsigned	ny_
Tensor< Vector< T, Size >, Dim >	data_
T	time_

Detailed Description

template<typename T, unsigned Dim = 2>
class LCS::FTLE< T, Dim >

Class for finite-time Lyapunov exponent (FTLE) fields.

This class is used for representing the finite-time Lyapunov exponent (FTLE) fields, which are scalar fields. It is a subclass of the Field class, and there is a FlowField associated with it.

Template Parameters

T	Numeric data type of the FTLE values.
Dim	Dimension of the FTLE field.

Inheritance diagram for LCS::FTLE< T, Dim >:

Constructor & Destructor Documentation

template<typename T , unsigned Dim = 2>

LCS::FTLE< T, Dim >::FTLE ( FlowField< T, Dim > &  ff )

inline

Constructor for initializing the FTLE field.

Parameters

ff	FlowField that is associated with the FTLE field.

Member Function Documentation

template<typename T , unsigned Dim = 2>

void LCS::FTLE< T, Dim >::Calculate ( )

inline

Calculate FTLE field from the flow map that is obtained from the flow field. OpenMP is used for calculation.

template<typename T , unsigned Dim = 2>

T LCS::FTLE< T, Dim >::Get ( const unsigned  i, const unsigned  j  ) const

inline

Get the FTLE value of the given point.

Parameters

i	Index in -coordinate.
j	Index in -coordinate.

Returns

FTLE value at the point.

---

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

• src/ftle.hpp