Jet  v1.3.3
Public Member Functions | Protected Member Functions | List of all members
jet::GridFractionalBoundaryConditionSolver2 Class Reference

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

#include <jet/grid_fractional_boundary_condition_solver2.h>

Inheritance diagram for jet::GridFractionalBoundaryConditionSolver2:
jet::GridBoundaryConditionSolver2 jet::GridBlockedBoundaryConditionSolver2

Public Member Functions

 GridFractionalBoundaryConditionSolver2 ()
 Default constructor. More...
 
virtual ~GridFractionalBoundaryConditionSolver2 ()
 Default destructor. More...
 
void constrainVelocity (FaceCenteredGrid2 *velocity, unsigned int extrapolationDepth=5) override
 
ScalarField2Ptr colliderSdf () const override
 Returns the signed distance field of the collider. More...
 
VectorField2Ptr colliderVelocityField () const override
 Returns the velocity field of the collider. More...
 
- Public Member Functions inherited from jet::GridBoundaryConditionSolver2
 GridBoundaryConditionSolver2 ()
 Default constructor. More...
 
virtual ~GridBoundaryConditionSolver2 ()
 Default destructor. More...
 
const Collider2Ptrcollider () const
 Returns associated collider. More...
 
void updateCollider (const Collider2Ptr &newCollider, const Size2 &gridSize, const Vector2D &gridSpacing, const Vector2D &gridOrigin)
 Applies new collider and build the internals. More...
 
int closedDomainBoundaryFlag () 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 Size2 &gridSize, const Vector2D &gridSpacing, const Vector2D &gridOrigin) override
 Invoked when a new collider is set. More...
 
- Protected Member Functions inherited from jet::GridBoundaryConditionSolver2
const Size2gridSize () const
 Returns the size of the velocity grid to be constrained. More...
 
const Vector2DgridSpacing () const
 Returns the spacing of the velocity grid to be constrained. More...
 
const Vector2DgridOrigin () 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 resolutional velocity projection.

Constructor & Destructor Documentation

◆ GridFractionalBoundaryConditionSolver2()

jet::GridFractionalBoundaryConditionSolver2::GridFractionalBoundaryConditionSolver2 ( )

Default constructor.

◆ ~GridFractionalBoundaryConditionSolver2()

virtual jet::GridFractionalBoundaryConditionSolver2::~GridFractionalBoundaryConditionSolver2 ( )
virtual

Default destructor.

Member Function Documentation

◆ colliderSdf()

ScalarField2Ptr jet::GridFractionalBoundaryConditionSolver2::colliderSdf ( ) const
overridevirtual

Returns the signed distance field of the collider.

Implements jet::GridBoundaryConditionSolver2.

◆ colliderVelocityField()

VectorField2Ptr jet::GridFractionalBoundaryConditionSolver2::colliderVelocityField ( ) const
overridevirtual

Returns the velocity field of the collider.

Implements jet::GridBoundaryConditionSolver2.

◆ constrainVelocity()

void jet::GridFractionalBoundaryConditionSolver2::constrainVelocity ( FaceCenteredGrid2 velocity,
unsigned int  extrapolationDepth = 5 
)
overridevirtual

Constrains the velocity field to conform the collider boundary.

Parameters
velocityInput and output velocity grid.
extrapolationDepthNumber of inner-collider grid cells that velocity will get extrapolated.

Implements jet::GridBoundaryConditionSolver2.

◆ onColliderUpdated()

void jet::GridFractionalBoundaryConditionSolver2::onColliderUpdated ( const Size2 gridSize,
const Vector2D gridSpacing,
const Vector2D gridOrigin 
)
overrideprotectedvirtual

Invoked when a new collider is set.

Implements jet::GridBoundaryConditionSolver2.


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