Abstract base class for 2-D grid-based pressure solver. More...

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

Inheritance diagram for CubbyFlow::GridPressureSolver2:

Public Member Functions
	GridPressureSolver2 ()=default
	Default constructor. More...

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

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

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

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

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

virtual void	Solve (const FaceCenteredGrid2 &input, double timeIntervalInSeconds, FaceCenteredGrid2 *output, const ScalarField2 &boundarySDF=ConstantScalarField2{ std::numeric_limits< double >::max() }, const VectorField2 &boundaryVelocity=ConstantVectorField2{ { 0, 0 } }, const ScalarField2 &fluidSDF=ConstantScalarField2{ -std::numeric_limits< double >::max() }, bool useCompressed=false)=0
	Solves the pressure term and apply it to the velocity field. More...

virtual GridBoundaryConditionSolver2Ptr	SuggestedBoundaryConditionSolver () const =0
	Returns the best boundary condition solver for this solver. More...

Detailed Description

Abstract base class for 2-D grid-based pressure solver.

This class represents a 2-D grid-based pressure solver interface which can be used as a sub-step of GridFluidSolver2. Inheriting classes must implement the core GridPressureSolver2::Solve function as well as the helper function GridPressureSolver2::SuggestedBoundaryConditionSolver.

Constructor & Destructor Documentation

◆ GridPressureSolver2() [1/3]

CubbyFlow::GridPressureSolver2::GridPressureSolver2 ( )

default

Default constructor.

◆ GridPressureSolver2() [2/3]

CubbyFlow::GridPressureSolver2::GridPressureSolver2 ( const GridPressureSolver2 & )

delete

Deleted copy constructor.

◆ GridPressureSolver2() [3/3]

CubbyFlow::GridPressureSolver2::GridPressureSolver2 ( GridPressureSolver2 && )

deletenoexcept

Deleted move constructor.

◆ ~GridPressureSolver2()

virtual CubbyFlow::GridPressureSolver2::~GridPressureSolver2 ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

◆ operator=() [1/2]

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

delete

Deleted copy assignment operator.

◆ operator=() [2/2]

GridPressureSolver2& CubbyFlow::GridPressureSolver2::operator= ( GridPressureSolver2 && )

deletenoexcept

Deleted move assignment operator.

◆ Solve()

virtual void CubbyFlow::GridPressureSolver2::Solve	(	const FaceCenteredGrid2 &	input,
		double	timeIntervalInSeconds,
		FaceCenteredGrid2 *	output,
		const ScalarField2 &	boundarySDF = `ConstantScalarField2{ std::numeric_limits< double >::max() }`,
		const VectorField2 &	boundaryVelocity = `ConstantVectorField2{ { 0, 0 } }`,
		const ScalarField2 &	fluidSDF = `ConstantScalarField2{ -std::numeric_limits< double >::max() }`,
		bool	useCompressed = `false`
	)

pure virtual

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.

Implemented in CubbyFlow::GridFractionalSinglePhasePressureSolver2, and CubbyFlow::GridSinglePhasePressureSolver2.

◆ SuggestedBoundaryConditionSolver()

virtual GridBoundaryConditionSolver2Ptr CubbyFlow::GridPressureSolver2::SuggestedBoundaryConditionSolver ( ) const