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

#include <Core/Solver/Grid/GridFractionalSinglePhasePressureSolver3.hpp>

Inheritance diagram for CubbyFlow::GridFractionalSinglePhasePressureSolver3:

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

	GridFractionalSinglePhasePressureSolver3 (const GridFractionalSinglePhasePressureSolver3 &)=delete
	Deleted copy constructor. More...

	GridFractionalSinglePhasePressureSolver3 (GridFractionalSinglePhasePressureSolver3 &&) noexcept=delete
	Deleted move constructor. More...

	~GridFractionalSinglePhasePressureSolver3 () override=default
	Default virtual destructor. More...

GridFractionalSinglePhasePressureSolver3 &	operator= (const GridFractionalSinglePhasePressureSolver3 &)=delete
	Deleted copy assignment operator. More...

GridFractionalSinglePhasePressureSolver3 &	operator= (GridFractionalSinglePhasePressureSolver3 &&) noexcept=delete
	Deleted move assignment operator. 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
	Default constructor. More...

	GridPressureSolver3 (const GridPressureSolver3 &)=delete
	Deleted copy constructor. More...

	GridPressureSolver3 (GridPressureSolver3 &&) noexcept=delete
	Deleted move constructor. More...

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

GridPressureSolver3 &	operator= (const GridPressureSolver3 &)=delete
	Deleted copy assignment operator. More...

GridPressureSolver3 &	operator= (GridPressureSolver3 &&) noexcept=delete
	Deleted move assignment operator. More...

Detailed Description

3-D fractional single-phase pressure solver.

This class implements 3-D fractional (or variational) single-phase pressure solver. It is called fractional because the solver encodes the boundaries to the grid cells like anti-aliased pixels, meaning that a grid cell will record the partially overlapping boundary as a fractional number. Alternative approach is to represent boundaries like Lego blocks which is the case for GridSinglePhasePressureSolver2. 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 fractional manner, meaning that the solver tries to capture the sub-grid structures. This class uses ghost fluid method for such calculation.

See also: Batty, Christopher, Florence Bertails, and Robert Bridson. "A fast variational framework for accurate solid-fluid coupling." ACM Transactions on Graphics (TOG). Vol. 26. No. 3. ACM, 2007.; Enright, Doug, et al. "Using the particle level set method and a second order accurate pressure boundary condition for free surface flows." ASME/JSME 2003 4th Joint Fluids Summer Engineering Conference. American Society of Mechanical Engineers, 2003.

Constructor & Destructor Documentation

◆ GridFractionalSinglePhasePressureSolver3() [1/3]

CubbyFlow::GridFractionalSinglePhasePressureSolver3::GridFractionalSinglePhasePressureSolver3 ( )

Default constructor.

◆ GridFractionalSinglePhasePressureSolver3() [2/3]

CubbyFlow::GridFractionalSinglePhasePressureSolver3::GridFractionalSinglePhasePressureSolver3 ( const GridFractionalSinglePhasePressureSolver3 & )

delete

Deleted copy constructor.

◆ GridFractionalSinglePhasePressureSolver3() [3/3]

CubbyFlow::GridFractionalSinglePhasePressureSolver3::GridFractionalSinglePhasePressureSolver3 ( GridFractionalSinglePhasePressureSolver3 && )

deletenoexcept

Deleted move constructor.

◆ ~GridFractionalSinglePhasePressureSolver3()

CubbyFlow::GridFractionalSinglePhasePressureSolver3::~GridFractionalSinglePhasePressureSolver3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

◆ GetLinearSystemSolver()

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

Returns the linear system solver.

◆ GetPressure()

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

Returns the pressure field.

◆ operator=() [1/2]

GridFractionalSinglePhasePressureSolver3& CubbyFlow::GridFractionalSinglePhasePressureSolver3::operator= ( const GridFractionalSinglePhasePressureSolver3 & )

delete

Deleted copy assignment operator.

◆ operator=() [2/2]

GridFractionalSinglePhasePressureSolver3& CubbyFlow::GridFractionalSinglePhasePressureSolver3::operator= ( GridFractionalSinglePhasePressureSolver3 && )

deletenoexcept

Deleted move assignment operator.

◆ SetLinearSystemSolver()

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

Sets the linear system solver.

◆ Solve()

void CubbyFlow::GridFractionalSinglePhasePressureSolver3::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::GridFractionalSinglePhasePressureSolver3::SuggestedBoundaryConditionSolver ( ) const