SPH
Classes | Public Member Functions | List of all members
SurfaceNormal Class Reference

Term computing normals of free surface. More...

#include <HelperTerms.h>

Inheritance diagram for SurfaceNormal:
IEquationTerm Polymorphic

Public Member Functions

virtual void setDerivatives (DerivativeHolder &derivatives, const RunSettings &settings) override
 Sets derivatives required by this term. More...
 
virtual void initialize (IScheduler &UNUSED(scheduler), Storage &UNUSED(storage), const Float UNUSED(t)) override
 
virtual void finalize (IScheduler &UNUSED(scheduler), Storage &UNUSED(storage), const Float UNUSED(t)) override
 
virtual void create (Storage &storage, IMaterial &UNUSED(material)) const override
 
- Public Member Functions inherited from IEquationTerm
virtual void initialize (IScheduler &scheduler, Storage &storage, const Float t)=0
 Initialize all the derivatives and/or quantity values before derivatives are computed. More...
 
virtual void finalize (IScheduler &scheduler, Storage &storage, const Float t)=0
 Computes all the derivatives and/or quantity values based on accumulated derivatives. More...
 
virtual void create (Storage &storage, IMaterial &material) const =0
 Creates all quantities needed by the term using given material. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Term computing normals of free surface.

For particles inside the bodies, this will result to vectors close to zero (depending on the number of neighbours), and the term can be therefore used to detect boundary particles

Definition at line 70 of file HelperTerms.h.

Member Function Documentation

◆ create()

virtual void SurfaceNormal::create ( Storage storage,
IMaterial UNUSEDmaterial 
) const
inlineoverridevirtual

Definition at line 121 of file HelperTerms.h.

◆ finalize()

virtual void SurfaceNormal::finalize ( IScheduler UNUSEDscheduler,
Storage UNUSEDstorage,
const Float   UNUSED
)
inlineoverridevirtual

Definition at line 117 of file HelperTerms.h.

◆ initialize()

virtual void SurfaceNormal::initialize ( IScheduler UNUSEDscheduler,
Storage UNUSEDstorage,
const Float   UNUSED
)
inlineoverridevirtual

Definition at line 113 of file HelperTerms.h.

◆ setDerivatives()

virtual void SurfaceNormal::setDerivatives ( DerivativeHolder derivatives,
const RunSettings settings 
)
inlineoverridevirtual

Sets derivatives required by this term.

The derivatives are then automatically evaluated by the solver, the equation term can access the result in finalize function. This function is called once for each thread at the beginning of the run.

Implements IEquationTerm.

Definition at line 109 of file HelperTerms.h.


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