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

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

#include <jet/grid_fractional_boundary_condition_solver3.h>

Inheritance diagram for jet::GridFractionalBoundaryConditionSolver3:
jet::GridBoundaryConditionSolver3 jet::GridBlockedBoundaryConditionSolver3

Public Member Functions

 GridFractionalBoundaryConditionSolver3 ()
 Default constructor. More...
 
virtual ~GridFractionalBoundaryConditionSolver3 ()
 Default destructor. More...
 
void constrainVelocity (FaceCenteredGrid3 *velocity, unsigned int extrapolationDepth=5) override
 
ScalarField3Ptr colliderSdf () const override
 Returns the signed distance field of the collider. More...
 
VectorField3Ptr colliderVelocityField () const override
 Returns the velocity field of the collider. More...
 
- Public Member Functions inherited from jet::GridBoundaryConditionSolver3
 GridBoundaryConditionSolver3 ()
 Default constructor. More...
 
virtual ~GridBoundaryConditionSolver3 ()
 Default destructor. More...
 
const Collider3Ptrcollider () const
 Returns associated collider. More...
 
void updateCollider (const Collider3Ptr &newCollider, const Size3 &gridSize, const Vector3D &gridSpacing, const Vector3D &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 Size3 &gridSize, const Vector3D &gridSpacing, const Vector3D &gridOrigin) override
 Invoked when a new collider is set. More...
 
- Protected Member Functions inherited from jet::GridBoundaryConditionSolver3
const Size3gridSize () const
 Returns the size of the velocity grid to be constrained. More...
 
const Vector3DgridSpacing () const
 Returns the spacing of the velocity grid to be constrained. More...
 
const Vector3DgridOrigin () const
 Returns the origin of the velocity grid to be constrained. More...
 

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 resolutional velocity projection.

Constructor & Destructor Documentation

◆ GridFractionalBoundaryConditionSolver3()

jet::GridFractionalBoundaryConditionSolver3::GridFractionalBoundaryConditionSolver3 ( )

Default constructor.

◆ ~GridFractionalBoundaryConditionSolver3()

virtual jet::GridFractionalBoundaryConditionSolver3::~GridFractionalBoundaryConditionSolver3 ( )
virtual

Default destructor.

Member Function Documentation

◆ colliderSdf()

ScalarField3Ptr jet::GridFractionalBoundaryConditionSolver3::colliderSdf ( ) const
overridevirtual

Returns the signed distance field of the collider.

Implements jet::GridBoundaryConditionSolver3.

◆ colliderVelocityField()

VectorField3Ptr jet::GridFractionalBoundaryConditionSolver3::colliderVelocityField ( ) const
overridevirtual

Returns the velocity field of the collider.

Implements jet::GridBoundaryConditionSolver3.

◆ constrainVelocity()

void jet::GridFractionalBoundaryConditionSolver3::constrainVelocity ( FaceCenteredGrid3 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::GridBoundaryConditionSolver3.

◆ onColliderUpdated()

void jet::GridFractionalBoundaryConditionSolver3::onColliderUpdated ( const Size3 gridSize,
const Vector3D gridSpacing,
const Vector3D gridOrigin 
)
overrideprotectedvirtual

Invoked when a new collider is set.

Implements jet::GridBoundaryConditionSolver3.


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