Jet  v1.3.3
Public Member Functions | List of all members
jet::GridDiffusionSolver3 Class Referenceabstract

Abstract base class for 3-D grid-based diffusion equation solver. More...

#include <jet/grid_diffusion_solver3.h>

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

Public Member Functions

 GridDiffusionSolver3 ()
 Default constructor. More...
 
virtual ~GridDiffusionSolver3 ()
 Default destructor. More...
 
virtual void solve (const ScalarGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, ScalarGrid3 *dest, const ScalarField3 &boundarySdf=ConstantScalarField3(kMaxD), const ScalarField3 &fluidSdf=ConstantScalarField3(-kMaxD))=0
 
virtual void solve (const CollocatedVectorGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, CollocatedVectorGrid3 *dest, const ScalarField3 &boundarySdf=ConstantScalarField3(kMaxD), const ScalarField3 &fluidSdf=ConstantScalarField3(-kMaxD))=0
 
virtual void solve (const FaceCenteredGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, FaceCenteredGrid3 *dest, const ScalarField3 &boundarySdf=ConstantScalarField3(kMaxD), const ScalarField3 &fluidSdf=ConstantScalarField3(-kMaxD))=0
 

Detailed Description

Abstract base class for 3-D grid-based diffusion equation solver.

This class provides functions to solve the diffusion equation for different types of fields. The target equation can be written as $\frac{\partial f}{\partial t} = \mu\nabla^2 f$ where $\mu$ is the diffusion coefficient. The field $f$ can be either scalar or vector field.

Constructor & Destructor Documentation

◆ GridDiffusionSolver3()

jet::GridDiffusionSolver3::GridDiffusionSolver3 ( )

Default constructor.

◆ ~GridDiffusionSolver3()

virtual jet::GridDiffusionSolver3::~GridDiffusionSolver3 ( )
virtual

Default destructor.

Member Function Documentation

◆ solve() [1/3]

virtual void jet::GridDiffusionSolver3::solve ( const CollocatedVectorGrid3 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
CollocatedVectorGrid3 dest,
const ScalarField3 boundarySdf = ConstantScalarField3(kMaxD),
const ScalarField3 fluidSdf = ConstantScalarField3(-kMaxD) 
)
pure virtual

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.
boundarySdfShape of the fluid boundary that is full by default.

Implemented in jet::GridBackwardEulerDiffusionSolver3, and jet::GridForwardEulerDiffusionSolver3.

◆ solve() [2/3]

virtual void jet::GridDiffusionSolver3::solve ( const FaceCenteredGrid3 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
FaceCenteredGrid3 dest,
const ScalarField3 boundarySdf = ConstantScalarField3(kMaxD),
const ScalarField3 fluidSdf = ConstantScalarField3(-kMaxD) 
)
pure virtual

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.
boundarySdfShape of the fluid boundary that is full by default.

Implemented in jet::GridBackwardEulerDiffusionSolver3, and jet::GridForwardEulerDiffusionSolver3.

◆ solve() [3/3]

virtual void jet::GridDiffusionSolver3::solve ( const ScalarGrid3 source,
double  diffusionCoefficient,
double  timeIntervalInSeconds,
ScalarGrid3 dest,
const ScalarField3 boundarySdf = ConstantScalarField3(kMaxD),
const ScalarField3 fluidSdf = ConstantScalarField3(-kMaxD) 
)
pure virtual

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.
boundarySdfShape of the fluid boundary that is full by default.

Implemented in jet::GridBackwardEulerDiffusionSolver3, and jet::GridForwardEulerDiffusionSolver3.


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