Jet  v1.3.3
Public Member Functions | List of all members
jet::GridForwardEulerDiffusionSolver2 Class Referencefinal

2-D grid-based forward Euler diffusion solver. More...

#include <jet/grid_forward_euler_diffusion_solver2.h>

Inheritance diagram for jet::GridForwardEulerDiffusionSolver2:
jet::GridDiffusionSolver2

Public Member Functions

 GridForwardEulerDiffusionSolver2 ()
 Default constructor. More...
 
void solve (const ScalarGrid2 &source, double diffusionCoefficient, double timeIntervalInSeconds, ScalarGrid2 *dest, const ScalarField2 &boundarySdf=ConstantScalarField2(kMaxD), const ScalarField2 &fluidSdf=ConstantScalarField2(-kMaxD)) override
 
void solve (const CollocatedVectorGrid2 &source, double diffusionCoefficient, double timeIntervalInSeconds, CollocatedVectorGrid2 *dest, const ScalarField2 &boundarySdf=ConstantScalarField2(kMaxD), const ScalarField2 &fluidSdf=ConstantScalarField2(-kMaxD)) override
 
void solve (const FaceCenteredGrid2 &source, double diffusionCoefficient, double timeIntervalInSeconds, FaceCenteredGrid2 *dest, const ScalarField2 &boundarySdf=ConstantScalarField2(kMaxD), const ScalarField2 &fluidSdf=ConstantScalarField2(-kMaxD)) override
 
- Public Member Functions inherited from jet::GridDiffusionSolver2
 GridDiffusionSolver2 ()
 Default constructor. More...
 
virtual ~GridDiffusionSolver2 ()
 Default destructor. More...
 

Detailed Description

2-D grid-based forward Euler diffusion solver.

This class implements 2-D grid-based forward Euler diffusion solver using second-order central differencing spatially. Since the method is relying on explicit time-integration (i.e. forward Euler), the diffusion coefficient is limited by the time interval and grid spacing such as: $\mu < \frac{h}{8\Delta t} $ where $\mu$, $h$, and $\Delta t$ are the diffusion coefficient, grid spacing, and time interval, respectively.

Constructor & Destructor Documentation

◆ GridForwardEulerDiffusionSolver2()

jet::GridForwardEulerDiffusionSolver2::GridForwardEulerDiffusionSolver2 ( )

Default constructor.

Member Function Documentation

◆ solve() [1/3]

void jet::GridForwardEulerDiffusionSolver2::solve ( const CollocatedVectorGrid2 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
CollocatedVectorGrid2 dest,
const ScalarField2 boundarySdf = ConstantScalarField2(kMaxD),
const ScalarField2 fluidSdf = ConstantScalarField2(-kMaxD) 
)
overridevirtual

Solves diffusion equation for a collocated vector field.

Parameters
sourceInput collocated vector field.
diffusionCoefficientAmount of diffusion.
timeIntervalInSecondsSmall time-interval that diffusion occur.
destOutput collocated vector field.
boundarySdfShape of the solid boundary that is empty by default.
fluidSdfShape of the fluid boundary that is full by default.

Implements jet::GridDiffusionSolver2.

◆ solve() [2/3]

void jet::GridForwardEulerDiffusionSolver2::solve ( const FaceCenteredGrid2 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
FaceCenteredGrid2 dest,
const ScalarField2 boundarySdf = ConstantScalarField2(kMaxD),
const ScalarField2 fluidSdf = ConstantScalarField2(-kMaxD) 
)
overridevirtual

Solves diffusion equation for a face-centered vector field.

Parameters
sourceInput face-centered vector field.
diffusionCoefficientAmount of diffusion.
timeIntervalInSecondsSmall time-interval that diffusion occur.
destOutput face-centered vector field.
boundarySdfShape of the solid boundary that is empty by default.
fluidSdfShape of the fluid boundary that is full by default.

Implements jet::GridDiffusionSolver2.

◆ solve() [3/3]

void jet::GridForwardEulerDiffusionSolver2::solve ( const ScalarGrid2 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
ScalarGrid2 dest,
const ScalarField2 boundarySdf = ConstantScalarField2(kMaxD),
const ScalarField2 fluidSdf = ConstantScalarField2(-kMaxD) 
)
overridevirtual

Solves diffusion equation for a scalar field.

Parameters
sourceInput scalar field.
diffusionCoefficientAmount of diffusion.
timeIntervalInSecondsSmall time-interval that diffusion occur.
destOutput scalar field.
boundarySdfShape of the solid boundary that is empty by default.
fluidSdfShape of the fluid boundary that is full by default.

Implements jet::GridDiffusionSolver2.


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