3-D single-phase pressure solver. More...

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

Inheritance diagram for CubbyFlow::GridSinglePhasePressureSolver3:

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

virtual	~GridSinglePhasePressureSolver3 ()
	Default destructor. More...

void	Solve (const FaceCenteredGrid3 &input, double timeIntervalInSeconds, FaceCenteredGrid3 *output, const ScalarField3 &boundarySDF=ConstantScalarField3(std::numeric_limits< double >::max()), const VectorField3 &boundaryVelocity=ConstantVectorField3({ 0, 0, 0 }), const ScalarField3 &fluidSDF=ConstantScalarField3(-std::numeric_limits< double >::max()), bool useCompressed=false) override
	Solves the pressure term and apply it to the velocity field. More...

GridBoundaryConditionSolver3Ptr	SuggestedBoundaryConditionSolver () const override
	Returns the best boundary condition solver for this solver. More...

const FDMLinearSystemSolver3Ptr &	GetLinearSystemSolver () const
	Returns the linear system solver. More...

void	SetLinearSystemSolver (const FDMLinearSystemSolver3Ptr &solver)
	Sets the linear system solver. More...

const FDMVector3 &	GetPressure () const
	Returns the pressure field. More...

Public Member Functions inherited from CubbyFlow::GridPressureSolver3
	GridPressureSolver3 ()
	Default constructor. More...

virtual	~GridPressureSolver3 ()
	Default destructor. More...

Detailed Description

3-D single-phase pressure solver.

This class implements 3-D single-phase pressure solver. This solver encodes the boundaries like Lego blocks – if a grid cell center is inside or outside the boundaries, it is either marked as occupied or not. In addition, this class solves single-phase flow, solving the pressure for selected fluid region only and treat other area as an atmosphere region. Thus, the pressure outside the fluid will be set to a constant value and velocity field won't be altered. This solver also computes the fluid boundary in block-like manner; If a grid cell is inside or outside the fluid, it is marked as either fluid or atmosphere. Thus, this solver in general, does not compute sub-grid structure.

Constructor & Destructor Documentation

◆ GridSinglePhasePressureSolver3()

CubbyFlow::GridSinglePhasePressureSolver3::GridSinglePhasePressureSolver3 ( )

Default constructor.

◆ ~GridSinglePhasePressureSolver3()

virtual CubbyFlow::GridSinglePhasePressureSolver3::~GridSinglePhasePressureSolver3 ( )

virtual

Default destructor.

Member Function Documentation

◆ GetLinearSystemSolver()

const FDMLinearSystemSolver3Ptr& CubbyFlow::GridSinglePhasePressureSolver3::GetLinearSystemSolver ( ) const

Returns the linear system solver.

◆ GetPressure()

const FDMVector3& CubbyFlow::GridSinglePhasePressureSolver3::GetPressure ( ) const

Returns the pressure field.

◆ SetLinearSystemSolver()

void CubbyFlow::GridSinglePhasePressureSolver3::SetLinearSystemSolver ( const FDMLinearSystemSolver3Ptr & solver )

Sets the linear system solver.

◆ Solve()

void CubbyFlow::GridSinglePhasePressureSolver3::Solve	(	const FaceCenteredGrid3 &	input,
		double	timeIntervalInSeconds,
		FaceCenteredGrid3 *	output,
		const ScalarField3 &	boundarySDF = `ConstantScalarField3(std::numeric_limits< double >::max())`,
		const VectorField3 &	boundaryVelocity = `ConstantVectorField3({ 0, 0, 0 })`,
		const ScalarField3 &	fluidSDF = `ConstantScalarField3(-std::numeric_limits< double >::max())`,
		bool	useCompressed = `false`
	)

overridevirtual

Solves the pressure term and apply it to the velocity field.

This function takes input velocity field and outputs pressure-applied velocity field. It also accepts extra arguments such as boundarySDF and fluidSDF that represent signed-distance representation of the boundary and fluid area. The negative region of boundarySDF means it is occupied by solid object. Also, the positive / negative area of the fluidSDF means it is occupied by fluid / atmosphere. If not specified, constant scalar field with std::numeric_limits<double>::max() will be used for boundarySDF meaning that no boundary at all. Similarly, a constant field with -std::numeric_limits<double>::max() will be used for fluidSDF which means it's fully occupied with fluid without any atmosphere.

Parameters

[in]	input	The input velocity field.
[in]	timeIntervalInSeconds	The time interval for the sim.
[in,out]	output	The output velocity field.
[in]	boundarySDF	The SDF of the boundary.
[in]	boundaryVelocity	The velocity of the boundary.
[in]	fluidSDF	The SDF of the fluid/atmosphere.
[in]	useCompressed	True if it uses compressed system.

Implements CubbyFlow::GridPressureSolver3.

◆ SuggestedBoundaryConditionSolver()

GridBoundaryConditionSolver3Ptr CubbyFlow::GridSinglePhasePressureSolver3::SuggestedBoundaryConditionSolver ( ) const