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

#include <Core/Solver/Grid/GridForwardEulerDiffusionSolver3.h>

Inheritance diagram for CubbyFlow::GridForwardEulerDiffusionSolver3:

Public Member Functions
	GridForwardEulerDiffusionSolver3 ()
	Default constructor. More...

void	Solve (const ScalarGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, ScalarGrid3 *dest, const ScalarField3 &boundarySDF=ConstantScalarField3(std::numeric_limits< double >::max()), const ScalarField3 &fluidSDF=ConstantScalarField3(-std::numeric_limits< double >::max())) override

void	Solve (const CollocatedVectorGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, CollocatedVectorGrid3 *dest, const ScalarField3 &boundarySDF=ConstantScalarField3(std::numeric_limits< double >::max()), const ScalarField3 &fluidSDF=ConstantScalarField3(-std::numeric_limits< double >::max())) override

void	Solve (const FaceCenteredGrid3 &source, double diffusionCoefficient, double timeIntervalInSeconds, FaceCenteredGrid3 *dest, const ScalarField3 &boundarySDF=ConstantScalarField3(std::numeric_limits< double >::max()), const ScalarField3 &fluidSDF=ConstantScalarField3(-std::numeric_limits< double >::max())) override

Public Member Functions inherited from CubbyFlow::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()

CubbyFlow::GridForwardEulerDiffusionSolver3::GridForwardEulerDiffusionSolver3 ( )

Default constructor.

Member Function Documentation

◆ Solve() [1/3]

void CubbyFlow::GridForwardEulerDiffusionSolver3::Solve	(	const ScalarGrid3 &	source,
		double	diffusionCoefficient,
		double	timeIntervalInSeconds,
		ScalarGrid3 *	dest,
		const ScalarField3 &	boundarySDF = `ConstantScalarField3(std::numeric_limits< double >::max())`,
		const ScalarField3 &	fluidSDF = `ConstantScalarField3(-std::numeric_limits< double >::max())`
	)

overridevirtual

Solves diffusion equation for a scalar field.

Parameters

source	Input scalar field.
diffusionCoefficient	Amount of diffusion.
timeIntervalInSeconds	Small time-interval that diffusion occur.
dest	Output scalar field.
boundarySDF	Shape of the solid boundary that is empty by default.
fluidSDF	Shape of the fluid boundary that is full by default.

Implements CubbyFlow::GridDiffusionSolver3.

◆ Solve() [2/3]

void CubbyFlow::GridForwardEulerDiffusionSolver3::Solve	(	const CollocatedVectorGrid3 &	source,
		double	diffusionCoefficient,
		double	timeIntervalInSeconds,
		CollocatedVectorGrid3 *	dest,
		const ScalarField3 &	boundarySDF = `ConstantScalarField3(std::numeric_limits< double >::max())`,
		const ScalarField3 &	fluidSDF = `ConstantScalarField3(-std::numeric_limits< double >::max())`
	)

overridevirtual

Solves diffusion equation for a collocated vector field.

Parameters

source	Input collocated vector field.
diffusionCoefficient	Amount of diffusion.
timeIntervalInSeconds	Small time-interval that diffusion occur.
dest	Output collocated vector field.
boundarySDF	Shape of the solid boundary that is empty by default.
fluidSDF	Shape of the fluid boundary that is full by default.

Implements CubbyFlow::GridDiffusionSolver3.

◆ Solve() [3/3]

void CubbyFlow::GridForwardEulerDiffusionSolver3::Solve	(	const FaceCenteredGrid3 &	source,
		double	diffusionCoefficient,
		double	timeIntervalInSeconds,
		FaceCenteredGrid3 *	dest,
		const ScalarField3 &	boundarySDF = `ConstantScalarField3(std::numeric_limits< double >::max())`,
		const ScalarField3 &	fluidSDF = `ConstantScalarField3(-std::numeric_limits< double >::max())`
	)

overridevirtual

Solves diffusion equation for a face-centered vector field.

Parameters

source	Input face-centered vector field.
diffusionCoefficient	Amount of diffusion.
timeIntervalInSeconds	Small time-interval that diffusion occur.
dest	Output face-centered vector field.
boundarySDF	Shape of the solid boundary that is empty by default.
fluidSDF	Shape of the fluid boundary that is full by default.

Implements CubbyFlow::GridDiffusionSolver3.

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

Core/Solver/Grid/GridForwardEulerDiffusionSolver3.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GridForwardEulerDiffusionSolver3()

Member Function Documentation

◆ Solve() [1/3]

◆ Solve() [2/3]

◆ Solve() [3/3]