Jet  v1.3.3
Public Member Functions | Protected Member Functions | List of all members
jet::SemiLagrangian3 Class Reference

Implementation of 3-D semi-Lagrangian advection solver. More...

#include <jet/semi_lagrangian3.h>

Inheritance diagram for jet::SemiLagrangian3:
jet::AdvectionSolver3 jet::CubicSemiLagrangian3

Public Member Functions

 SemiLagrangian3 ()
 
virtual ~SemiLagrangian3 ()
 
void advect (const ScalarGrid3 &input, const VectorField3 &flow, double dt, ScalarGrid3 *output, const ScalarField3 &boundarySdf=ConstantScalarField3(std::numeric_limits< double >::max())) final
 Computes semi-Langian for given scalar grid. More...
 
void advect (const CollocatedVectorGrid3 &input, const VectorField3 &flow, double dt, CollocatedVectorGrid3 *output, const ScalarField3 &boundarySdf=ConstantScalarField3(std::numeric_limits< double >::max())) final
 Computes semi-Langian for given collocated vector grid. More...
 
void advect (const FaceCenteredGrid3 &input, const VectorField3 &flow, double dt, FaceCenteredGrid3 *output, const ScalarField3 &boundarySdf=ConstantScalarField3(std::numeric_limits< double >::max())) final
 Computes semi-Langian for given face-centered vector grid. More...
 
- Public Member Functions inherited from jet::AdvectionSolver3
 AdvectionSolver3 ()
 
virtual ~AdvectionSolver3 ()
 

Protected Member Functions

virtual std::function< double(const Vector3D &)> getScalarSamplerFunc (const ScalarGrid3 &input) const
 Returns spatial interpolation function object for given scalar grid. More...
 
virtual std::function< Vector3D(const Vector3D &)> getVectorSamplerFunc (const CollocatedVectorGrid3 &input) const
 Returns spatial interpolation function object for given collocated vector grid. More...
 
virtual std::function< Vector3D(const Vector3D &)> getVectorSamplerFunc (const FaceCenteredGrid3 &input) const
 Returns spatial interpolation function object for given face-centered vector grid. More...
 

Detailed Description

Implementation of 3-D semi-Lagrangian advection solver.

This class implements 3-D semi-Lagrangian advection solver. By default, the class implements 1st-order (linear) algorithm for the spatial interpolation. For the back-tracing, this class uses 2nd-order mid-point rule with adaptive time-stepping (CFL <= 1). To extend the class using higher-order spatial interpolation, the inheriting classes can override SemiLagrangian2::getScalarSamplerFunc and SemiLagrangian2::getVectorSamplerFunc. See CubicSemiLagrangian2 for example.

Constructor & Destructor Documentation

◆ SemiLagrangian3()

jet::SemiLagrangian3::SemiLagrangian3 ( )

◆ ~SemiLagrangian3()

virtual jet::SemiLagrangian3::~SemiLagrangian3 ( )
virtual

Member Function Documentation

◆ advect() [1/3]

void jet::SemiLagrangian3::advect ( const CollocatedVectorGrid3 input,
const VectorField3 flow,
double  dt,
CollocatedVectorGrid3 output,
const ScalarField3 boundarySdf = ConstantScalarField3(std::numeric_limits< double >::max()) 
)
finalvirtual

Computes semi-Langian for given collocated vector grid.

This function computes semi-Lagrangian method to solve advection equation for given collocated vector grid input and underlying vector field flow that carries the input field. The solution after solving the equation for given time-step dt should be stored in scalar field output. The boundary interface is given by a signed-distance field. The field is negative inside the boundary. By default, a constant field with max double value (kMaxD) is used, meaning no boundary.

Parameters
inputInput vector grid.
flowVector field that advects the input field.
dtTime-step for the advection.
outputOutput vector grid.
boundarySdfBoundary interface defined by signed-distance field.

Reimplemented from jet::AdvectionSolver3.

◆ advect() [2/3]

void jet::SemiLagrangian3::advect ( const FaceCenteredGrid3 input,
const VectorField3 flow,
double  dt,
FaceCenteredGrid3 output,
const ScalarField3 boundarySdf = ConstantScalarField3(std::numeric_limits< double >::max()) 
)
finalvirtual

Computes semi-Langian for given face-centered vector grid.

This function computes semi-Lagrangian method to solve advection equation for given face-centered vector grid input and underlying vector field flow that carries the input field. The solution after solving the equation for given time-step dt should be stored in vector field output. The boundary interface is given by a signed-distance field. The field is negative inside the boundary. By default, a constant field with max double value (kMaxD) is used, meaning no boundary.

Parameters
inputInput vector grid.
flowVector field that advects the input field.
dtTime-step for the advection.
outputOutput vector grid.
boundarySdfBoundary interface defined by signed-distance field.

Reimplemented from jet::AdvectionSolver3.

◆ advect() [3/3]

void jet::SemiLagrangian3::advect ( const ScalarGrid3 input,
const VectorField3 flow,
double  dt,
ScalarGrid3 output,
const ScalarField3 boundarySdf = ConstantScalarField3(std::numeric_limits< double >::max()) 
)
finalvirtual

Computes semi-Langian for given scalar grid.

This function computes semi-Lagrangian method to solve advection equation for given scalar field input and underlying vector field flow that carries the input field. The solution after solving the equation for given time-step dt should be stored in scalar field output. The boundary interface is given by a signed-distance field. The field is negative inside the boundary. By default, a constant field with max double value (kMaxD) is used, meaning no boundary.

Parameters
inputInput scalar grid.
flowVector field that advects the input field.
dtTime-step for the advection.
outputOutput scalar grid.
boundarySdfBoundary interface defined by signed-distance field.

Implements jet::AdvectionSolver3.

◆ getScalarSamplerFunc()

virtual std::function<double(const Vector3D&)> jet::SemiLagrangian3::getScalarSamplerFunc ( const ScalarGrid3 input) const
protectedvirtual

Returns spatial interpolation function object for given scalar grid.

This function returns spatial interpolation function (sampler) for given scalar grid input. By default, this function returns linear interpolation function. Override this function to have custom interpolation for semi-Lagrangian process.

Reimplemented in jet::CubicSemiLagrangian3.

◆ getVectorSamplerFunc() [1/2]

virtual std::function<Vector3D(const Vector3D&)> jet::SemiLagrangian3::getVectorSamplerFunc ( const CollocatedVectorGrid3 input) const
protectedvirtual

Returns spatial interpolation function object for given collocated vector grid.

This function returns spatial interpolation function (sampler) for given collocated vector grid input. By default, this function returns linear interpolation function. Override this function to have custom interpolation for semi-Lagrangian process.

Reimplemented in jet::CubicSemiLagrangian3.

◆ getVectorSamplerFunc() [2/2]

virtual std::function<Vector3D(const Vector3D&)> jet::SemiLagrangian3::getVectorSamplerFunc ( const FaceCenteredGrid3 input) const
protectedvirtual

Returns spatial interpolation function object for given face-centered vector grid.

This function returns spatial interpolation function (sampler) for given face-centered vector grid input. By default, this function returns linear interpolation function. Override this function to have custom interpolation for semi-Lagrangian process.

Reimplemented in jet::CubicSemiLagrangian3.


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