CubbyFlow::GridFractionalBoundaryConditionSolver2 Class Reference

Fractional 2-D boundary condition solver for grids. More...

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

Inheritance diagram for CubbyFlow::GridFractionalBoundaryConditionSolver2:

Public Member Functions
	GridFractionalBoundaryConditionSolver2 ()=default
	Default constructor. More...
	GridFractionalBoundaryConditionSolver2 (const GridFractionalBoundaryConditionSolver2 &)=delete
	Deleted copy constructor. More...
	GridFractionalBoundaryConditionSolver2 (GridFractionalBoundaryConditionSolver2 &&) noexcept=delete
	Deleted move constructor. More...
	~GridFractionalBoundaryConditionSolver2 () override=default
	Default virtual destructor. More...
GridFractionalBoundaryConditionSolver2 &	operator= (const GridFractionalBoundaryConditionSolver2 &)=delete
	Deleted copy assignment operator. More...
GridFractionalBoundaryConditionSolver2 &	operator= (GridFractionalBoundaryConditionSolver2 &&) noexcept=delete
	Deleted move assignment operator. More...
void	ConstrainVelocity (FaceCenteredGrid2 *velocity, unsigned int extrapolationDepth=5) override
ScalarField2Ptr	GetColliderSDF () const override
	Returns the signed distance field of the collider. More...
VectorField2Ptr	GetColliderVelocityField () const override
	Returns the velocity field of the collider. More...
Public Member Functions inherited from CubbyFlow::GridBoundaryConditionSolver2
	GridBoundaryConditionSolver2 ()=default
	Default constructor. More...
	GridBoundaryConditionSolver2 (const GridBoundaryConditionSolver2 &)=delete
	Deleted copy constructor. More...
	GridBoundaryConditionSolver2 (GridBoundaryConditionSolver2 &&) noexcept=delete
	Deleted move constructor. More...
virtual	~GridBoundaryConditionSolver2 ()=default
	Default virtual destructor. More...
GridBoundaryConditionSolver2 &	operator= (const GridBoundaryConditionSolver2 &)=delete
	Deleted copy assignment operator. More...
GridBoundaryConditionSolver2 &	operator= (GridBoundaryConditionSolver2 &&) noexcept=delete
	Deleted move assignment operator. More...
const Collider2Ptr &	GetCollider () const
	Returns associated collider. More...
void	UpdateCollider (const Collider2Ptr &newCollider, const Vector2UZ &gridSize, const Vector2D &gridSpacing, const Vector2D &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 Vector2UZ &gridSize, const Vector2D &gridSpacing, const Vector2D &gridOrigin) override
	Invoked when a new collider is set. More...
Protected Member Functions inherited from CubbyFlow::GridBoundaryConditionSolver2
const Vector2UZ &	GetGridSize () const
	Returns the size of the velocity grid to be constrained. More...
const Vector2D &	GetGridSpacing () const
	Returns the spacing of the velocity grid to be constrained. More...
const Vector2D &	GetGridOrigin () const
	Returns the origin of the velocity grid to be constrained. More...

Detailed Description

Fractional 2-D boundary condition solver for grids.

This class constrains the velocity field by projecting the flow to the signed-distance field representation of the collider. This implementation should pair up with GridFractionalSinglePhasePressureSolver2 to provide sub-grid resolution velocity projection.

Constructor & Destructor Documentation

GridFractionalBoundaryConditionSolver2() [1/3]

CubbyFlow::GridFractionalBoundaryConditionSolver2::GridFractionalBoundaryConditionSolver2 ( )

default

Default constructor.

GridFractionalBoundaryConditionSolver2() [2/3]

CubbyFlow::GridFractionalBoundaryConditionSolver2::GridFractionalBoundaryConditionSolver2 ( const GridFractionalBoundaryConditionSolver2 &  )

delete

Deleted copy constructor.

GridFractionalBoundaryConditionSolver2() [3/3]

CubbyFlow::GridFractionalBoundaryConditionSolver2::GridFractionalBoundaryConditionSolver2 ( GridFractionalBoundaryConditionSolver2 &&  )

deletenoexcept

Deleted move constructor.

~GridFractionalBoundaryConditionSolver2()

CubbyFlow::GridFractionalBoundaryConditionSolver2::~GridFractionalBoundaryConditionSolver2 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

ConstrainVelocity()

void CubbyFlow::GridFractionalBoundaryConditionSolver2::ConstrainVelocity ( FaceCenteredGrid2 *  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::GridBoundaryConditionSolver2.

GetColliderSDF()

ScalarField2Ptr CubbyFlow::GridFractionalBoundaryConditionSolver2::GetColliderSDF ( ) const

overridevirtual

Returns the signed distance field of the collider.

Implements CubbyFlow::GridBoundaryConditionSolver2.

GetColliderVelocityField()

VectorField2Ptr CubbyFlow::GridFractionalBoundaryConditionSolver2::GetColliderVelocityField ( ) const

overridevirtual

Returns the velocity field of the collider.

Implements CubbyFlow::GridBoundaryConditionSolver2.

OnColliderUpdated()

void CubbyFlow::GridFractionalBoundaryConditionSolver2::OnColliderUpdated ( const Vector2UZ &  gridSize, const Vector2D &  gridSpacing, const Vector2D &  gridOrigin  )

overrideprotectedvirtual

Invoked when a new collider is set.

Implements CubbyFlow::GridBoundaryConditionSolver2.

operator=() [1/2]

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

delete

Deleted copy assignment operator.

operator=() [2/2]

GridFractionalBoundaryConditionSolver2& CubbyFlow::GridFractionalBoundaryConditionSolver2::operator= ( GridFractionalBoundaryConditionSolver2 &&  )

deletenoexcept

Deleted move assignment operator.

---

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

• Core/Solver/Grid/GridFractionalBoundaryConditionSolver2.hpp