CubbyFlow::GridFractionalBoundaryConditionSolver3 Class Reference

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

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

Inheritance diagram for CubbyFlow::GridFractionalBoundaryConditionSolver3:

Public Member Functions
	GridFractionalBoundaryConditionSolver3 ()=default
	Default constructor.
	GridFractionalBoundaryConditionSolver3 (const GridFractionalBoundaryConditionSolver3 &)=delete
	Deleted copy constructor.
	GridFractionalBoundaryConditionSolver3 (GridFractionalBoundaryConditionSolver3 &&) noexcept=delete
	Deleted move constructor.
	~GridFractionalBoundaryConditionSolver3 () override=default
	Default virtual destructor.
GridFractionalBoundaryConditionSolver3 &	operator= (const GridFractionalBoundaryConditionSolver3 &)=delete
	Deleted copy assignment operator.
GridFractionalBoundaryConditionSolver3 &	operator= (GridFractionalBoundaryConditionSolver3 &&) noexcept=delete
	Deleted move assignment operator.
void	ConstrainVelocity (FaceCenteredGrid3 *velocity, unsigned int extrapolationDepth=5) override
ScalarField3Ptr	GetColliderSDF () const override
	Returns the signed distance field of the collider.
VectorField3Ptr	GetColliderVelocityField () const override
	Returns the velocity field of the collider.
Public Member Functions inherited from CubbyFlow::GridBoundaryConditionSolver3
	GridBoundaryConditionSolver3 ()=default
	Default constructor.
	GridBoundaryConditionSolver3 (const GridBoundaryConditionSolver3 &)=delete
	Deleted copy constructor.
	GridBoundaryConditionSolver3 (GridBoundaryConditionSolver3 &&) noexcept=delete
	Deleted move constructor.
virtual	~GridBoundaryConditionSolver3 ()=default
	Default virtual destructor.
GridBoundaryConditionSolver3 &	operator= (const GridBoundaryConditionSolver3 &)=delete
	Deleted copy assignment operator.
GridBoundaryConditionSolver3 &	operator= (GridBoundaryConditionSolver3 &&) noexcept=delete
	Deleted move assignment operator.
const Collider3Ptr &	GetCollider () const
	Returns associated collider.
void	UpdateCollider (const Collider3Ptr &newCollider, const Vector3UZ &gridSize, const Vector3D &gridSpacing, const Vector3D &gridOrigin)
	Applies new collider and build the internals.
int	GetClosedDomainBoundaryFlag () const
	Returns the closed domain boundary flag.
void	SetClosedDomainBoundaryFlag (int flag)
	Sets the closed domain boundary flag.

Protected Member Functions
void	OnColliderUpdated (const Vector3UZ &gridSize, const Vector3D &gridSpacing, const Vector3D &gridOrigin) override
	Invoked when a new collider is set.
Protected Member Functions inherited from CubbyFlow::GridBoundaryConditionSolver3
const Vector3UZ &	GetGridSize () const
	Returns the size of the velocity grid to be constrained.
const Vector3D &	GetGridSpacing () const
	Returns the spacing of the velocity grid to be constrained.
const Vector3D &	GetGridOrigin () const
	Returns the origin of the velocity grid to be constrained.

Detailed Description

Fractional 3-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 GridFractionalSinglePhasePressureSolver3 to provide sub-grid resolution velocity projection.

Constructor & Destructor Documentation

GridFractionalBoundaryConditionSolver3() [1/3]

CubbyFlow::GridFractionalBoundaryConditionSolver3::GridFractionalBoundaryConditionSolver3 ( )

default

Default constructor.

GridFractionalBoundaryConditionSolver3() [2/3]

CubbyFlow::GridFractionalBoundaryConditionSolver3::GridFractionalBoundaryConditionSolver3 ( const GridFractionalBoundaryConditionSolver3 &  )

delete

Deleted copy constructor.

GridFractionalBoundaryConditionSolver3() [3/3]

CubbyFlow::GridFractionalBoundaryConditionSolver3::GridFractionalBoundaryConditionSolver3 ( GridFractionalBoundaryConditionSolver3 &&  )

deletenoexcept

Deleted move constructor.

~GridFractionalBoundaryConditionSolver3()

CubbyFlow::GridFractionalBoundaryConditionSolver3::~GridFractionalBoundaryConditionSolver3 ( )

overridedefault

Default virtual destructor.

Member Function Documentation

ConstrainVelocity()

void CubbyFlow::GridFractionalBoundaryConditionSolver3::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.

GetColliderSDF()

ScalarField3Ptr CubbyFlow::GridFractionalBoundaryConditionSolver3::GetColliderSDF ( ) const

overridevirtual

Returns the signed distance field of the collider.

Implements CubbyFlow::GridBoundaryConditionSolver3.

GetColliderVelocityField()

VectorField3Ptr CubbyFlow::GridFractionalBoundaryConditionSolver3::GetColliderVelocityField ( ) const

overridevirtual

Returns the velocity field of the collider.

Implements CubbyFlow::GridBoundaryConditionSolver3.

OnColliderUpdated()

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

overrideprotectedvirtual

Invoked when a new collider is set.

Implements CubbyFlow::GridBoundaryConditionSolver3.

operator=() [1/2]

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

delete

Deleted copy assignment operator.

operator=() [2/2]

GridFractionalBoundaryConditionSolver3 & CubbyFlow::GridFractionalBoundaryConditionSolver3::operator= ( GridFractionalBoundaryConditionSolver3 &&  )

deletenoexcept

Deleted move assignment operator.

---

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

• Core/Solver/Grid/GridFractionalBoundaryConditionSolver3.hpp