SPH
Public Member Functions | List of all members
IBoundaryCondition Class Referenceabstract

Base object for boundary conditions. More...

#include <Boundary.h>

Inheritance diagram for IBoundaryCondition:
Polymorphic FixedParticles FrozenParticles GhostParticles KillEscapersBoundary NullBoundaryCondition PeriodicBoundary Projection1D SodBc SymmetricBoundary

Public Member Functions

virtual void initialize (Storage &storage)=0
 Applies the boundary conditions before the derivatives are computed. More...
 
virtual void finalize (Storage &storage)=0
 Applies the boundary conditions after the derivatives are computed. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Base object for boundary conditions.

All boundary conditions behave similarly to equation terms, meaning they can modify the storage each time step before the derivatives are computed (in initialize function) and after derivatives are computed (in finalize function). They do not create any quantities nor they compute derivatives. In solver, boundary conditions are evaluated after all the equations have been evaluated. This is needed in order to copy the correct quantities on ghosts, make sure that derivatives are zero/clamped as needed, etc.

Definition at line 29 of file Boundary.h.

Member Function Documentation

◆ finalize()

virtual void IBoundaryCondition::finalize ( Storage storage)
pure virtual

Applies the boundary conditions after the derivatives are computed.

Called every time step after equations are evaluated (finalized).

Implemented in Projection1D, KillEscapersBoundary, SymmetricBoundary, PeriodicBoundary, WindTunnel, FrozenParticles, FixedParticles, GhostParticles, and SodBc.

◆ initialize()

virtual void IBoundaryCondition::initialize ( Storage storage)
pure virtual

Applies the boundary conditions before the derivatives are computed.

Called every time step after equations are initialized.

Implemented in KillEscapersBoundary, SymmetricBoundary, PeriodicBoundary, FixedParticles, GhostParticles, and SodBc.


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