Blocked 3-D boundary condition solver for grids. More...

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

Inheritance diagram for CubbyFlow::GridBlockedBoundaryConditionSolver3:

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

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

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

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

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

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

void	ConstrainVelocity (FaceCenteredGrid3 *velocity, unsigned int extrapolationDepth=5) override

const Array3< char > &	GetMarker () const
	Returns the marker which is 1 if occupied by the collider. More...

Public Member Functions inherited from CubbyFlow::GridFractionalBoundaryConditionSolver3
	GridFractionalBoundaryConditionSolver3 ()=default
	Default constructor. More...

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

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

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

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

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

void	ConstrainVelocity (FaceCenteredGrid3 *velocity, unsigned int extrapolationDepth=5) override

ScalarField3Ptr	GetColliderSDF () const override
	Returns the signed distance field of the collider. More...

VectorField3Ptr	GetColliderVelocityField () const override
	Returns the velocity field of the collider. More...

Public Member Functions inherited from CubbyFlow::GridBoundaryConditionSolver3
	GridBoundaryConditionSolver3 ()=default
	Default constructor. More...

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

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

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

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

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

const Collider3Ptr &	GetCollider () const
	Returns associated collider. More...

void	UpdateCollider (const Collider3Ptr &newCollider, const Vector3UZ &gridSize, const Vector3D &gridSpacing, const Vector3D &gridOrigin)
	Applies new collider and build the internals. More...

int	GetClosedDomainBoundaryFlag () const
	Returns the closed domain boundary flag. More...

void	SetClosedDomainBoundaryFlag (int flag)
	Sets the closed domain boundary flag. More...

Protected Member Functions
void	OnColliderUpdated (const Vector3UZ &gridSize, const Vector3D &gridSpacing, const Vector3D &gridOrigin) override
	Invoked when a new collider is set. More...

Protected Member Functions inherited from CubbyFlow::GridFractionalBoundaryConditionSolver3
void	OnColliderUpdated (const Vector3UZ &gridSize, const Vector3D &gridSpacing, const Vector3D &gridOrigin) override
	Invoked when a new collider is set. More...

Protected Member Functions inherited from CubbyFlow::GridBoundaryConditionSolver3
const Vector3UZ &	GetGridSize () const
	Returns the size of the velocity grid to be constrained. More...

const Vector3D &	GetGridSpacing () const
	Returns the spacing of the velocity grid to be constrained. More...

const Vector3D &	GetGridOrigin () const
	Returns the origin of the velocity grid to be constrained. More...

Detailed Description

Blocked 3-D boundary condition solver for grids.

This class constrains the velocity field by projecting the flow to the blocked representation of the collider. A collider is rasterized into voxels and each face of the collider voxels projects the velocity field onto its face. This implementation should pair up with GridSinglePhasePressureSolver3 since the pressure solver assumes blocked boundary representation as well.

Constructor & Destructor Documentation

◆ GridBlockedBoundaryConditionSolver3() [1/3]

CubbyFlow::GridBlockedBoundaryConditionSolver3::GridBlockedBoundaryConditionSolver3 ( )

default

Default constructor.

◆ GridBlockedBoundaryConditionSolver3() [2/3]

CubbyFlow::GridBlockedBoundaryConditionSolver3::GridBlockedBoundaryConditionSolver3 ( const GridBlockedBoundaryConditionSolver3 & )

delete

Deleted copy constructor.

◆ GridBlockedBoundaryConditionSolver3() [3/3]

CubbyFlow::GridBlockedBoundaryConditionSolver3::GridBlockedBoundaryConditionSolver3 ( GridBlockedBoundaryConditionSolver3 && )

deletenoexcept

Deleted move constructor.

◆ ~GridBlockedBoundaryConditionSolver3()

CubbyFlow::GridBlockedBoundaryConditionSolver3::~GridBlockedBoundaryConditionSolver3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

◆ ConstrainVelocity()

void CubbyFlow::GridBlockedBoundaryConditionSolver3::ConstrainVelocity	(	FaceCenteredGrid3 *	velocity,
		unsigned int	extrapolationDepth = `5`
	)

overridevirtual

Constrains the velocity field to conform the collider boundary.

Parameters

velocity	Input and output velocity grid.
extrapolationDepth	Number of inner-collider grid cells that velocity will get extrapolated.

Implements CubbyFlow::GridBoundaryConditionSolver3.

◆ GetMarker()

const Array3<char>& CubbyFlow::GridBlockedBoundaryConditionSolver3::GetMarker ( ) const

Returns the marker which is 1 if occupied by the collider.

◆ OnColliderUpdated()

void CubbyFlow::GridBlockedBoundaryConditionSolver3::OnColliderUpdated	(	const Vector3UZ &	gridSize,
		const Vector3D &	gridSpacing,
		const Vector3D &	gridOrigin
	)

overrideprotectedvirtual

Invoked when a new collider is set.

Implements CubbyFlow::GridBoundaryConditionSolver3.

◆ operator=() [1/2]

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

delete

Deleted copy assignment operator.

◆ operator=() [2/2]

GridBlockedBoundaryConditionSolver3& CubbyFlow::GridBlockedBoundaryConditionSolver3::operator= ( GridBlockedBoundaryConditionSolver3 && )