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

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

#include <jet/grid_forward_euler_diffusion_solver3.h>

Inheritance diagram for jet::GridForwardEulerDiffusionSolver3:
jet::GridDiffusionSolver3

Public Member Functions

 GridForwardEulerDiffusionSolver3 ()
 Default constructor. More...
 
void solve (const ScalarGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, ScalarGrid3 *dest, const ScalarField3 &boundarySdf=ConstantScalarField3(kMaxD), const ScalarField3 &fluidSdf=ConstantScalarField3(-kMaxD)) override
 
void solve (const CollocatedVectorGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, CollocatedVectorGrid3 *dest, const ScalarField3 &boundarySdf=ConstantScalarField3(kMaxD), const ScalarField3 &fluidSdf=ConstantScalarField3(-kMaxD)) override
 
void solve (const FaceCenteredGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, FaceCenteredGrid3 *dest, const ScalarField3 &boundarySdf=ConstantScalarField3(kMaxD), const ScalarField3 &fluidSdf=ConstantScalarField3(-kMaxD)) override
 
- Public Member Functions inherited from jet::GridDiffusionSolver3
 GridDiffusionSolver3 ()
 Default constructor. More...
 
virtual ~GridDiffusionSolver3 ()
 Default destructor. More...
 

Detailed Description

3-D grid-based forward Euler diffusion solver.

This class implements 3-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}{12\Delta t} $ where $\mu$, $h$, and $\Delta t$ are the diffusion coefficient, grid spacing, and time interval, respectively.

Constructor & Destructor Documentation

◆ GridForwardEulerDiffusionSolver3()

jet::GridForwardEulerDiffusionSolver3::GridForwardEulerDiffusionSolver3 ( )

Default constructor.

Member Function Documentation

◆ solve() [1/3]

void jet::GridForwardEulerDiffusionSolver3::solve ( const CollocatedVectorGrid3 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
CollocatedVectorGrid3 dest,
const ScalarField3 boundarySdf = ConstantScalarField3(kMaxD),
const ScalarField3 fluidSdf = ConstantScalarField3(-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::GridDiffusionSolver3.

◆ solve() [2/3]

void jet::GridForwardEulerDiffusionSolver3::solve ( const FaceCenteredGrid3 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
FaceCenteredGrid3 dest,
const ScalarField3 boundarySdf = ConstantScalarField3(kMaxD),
const ScalarField3 fluidSdf = ConstantScalarField3(-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::GridDiffusionSolver3.

◆ solve() [3/3]

void jet::GridForwardEulerDiffusionSolver3::solve ( const ScalarGrid3 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
ScalarGrid3 dest,
const ScalarField3 boundarySdf = ConstantScalarField3(kMaxD),
const ScalarField3 fluidSdf = ConstantScalarField3(-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::GridDiffusionSolver3.


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