SPH
Public Member Functions | List of all members
ChaiScriptTerm Class Reference

#include <HelperTerms.h>

Inheritance diagram for ChaiScriptTerm:
IEquationTerm Polymorphic

Public Member Functions

 ChaiScriptTerm (const Path &scriptFile, const Float period, const bool oneShot)
 
virtual void setDerivatives (DerivativeHolder &UNUSED(derivatives), const RunSettings &UNUSED(settings)) override
 
virtual void initialize (IScheduler &UNUSED(scheduler), Storage &UNUSED(storage), const Float UNUSED(t)) override
 
virtual void finalize (IScheduler &UNUSED(scheduler), Storage &storage, const Float t) override
 
virtual void create (Storage &UNUSED(storage), IMaterial &UNUSED(material)) const override
 
- Public Member Functions inherited from IEquationTerm
virtual void setDerivatives (DerivativeHolder &derivatives, const RunSettings &settings)=0
 Sets derivatives required by this term. More...
 
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

Definition at line 126 of file HelperTerms.h.

Constructor & Destructor Documentation

◆ ChaiScriptTerm()

ChaiScriptTerm::ChaiScriptTerm ( const Path scriptFile,
const Float  period,
const bool  oneShot 
)
inlineexplicit

Definition at line 139 of file HelperTerms.h.

Member Function Documentation

◆ create()

virtual void ChaiScriptTerm::create ( Storage UNUSEDstorage,
IMaterial UNUSEDmaterial 
) const
inlineoverridevirtual

Definition at line 185 of file HelperTerms.h.

◆ finalize()

virtual void ChaiScriptTerm::finalize ( IScheduler UNUSEDscheduler,
Storage storage,
const Float  t 
)
inlineoverridevirtual

Definition at line 159 of file HelperTerms.h.

◆ initialize()

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

Definition at line 155 of file HelperTerms.h.

◆ setDerivatives()

virtual void ChaiScriptTerm::setDerivatives ( DerivativeHolder UNUSEDderivatives,
const RunSettings UNUSEDsettings 
)
inlineoverridevirtual

Definition at line 152 of file HelperTerms.h.


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