SPH
Public Member Functions | List of all members
Tests::SingleDerivativeMaker< TDerivative > Struct Template Reference

#include <Setup.h>

Inheritance diagram for Tests::SingleDerivativeMaker< TDerivative >:
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 &UNUSED(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

template<typename TDerivative>
struct Tests::SingleDerivativeMaker< TDerivative >

Definition at line 65 of file Setup.h.

Member Function Documentation

◆ create()

template<typename TDerivative >
virtual void Tests::SingleDerivativeMaker< TDerivative >::create ( Storage UNUSEDstorage,
IMaterial UNUSEDmaterial 
) const
inlineoverridevirtual

Definition at line 78 of file Setup.h.

◆ finalize()

template<typename TDerivative >
virtual void Tests::SingleDerivativeMaker< TDerivative >::finalize ( IScheduler UNUSEDscheduler,
Storage UNUSEDstorage,
const Float   UNUSED
)
inlineoverridevirtual

Definition at line 74 of file Setup.h.

◆ initialize()

template<typename TDerivative >
virtual void Tests::SingleDerivativeMaker< TDerivative >::initialize ( IScheduler UNUSEDscheduler,
Storage UNUSEDstorage,
const Float   UNUSED
)
inlineoverridevirtual

Definition at line 70 of file Setup.h.

◆ setDerivatives()

template<typename TDerivative >
virtual void Tests::SingleDerivativeMaker< TDerivative >::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 66 of file Setup.h.


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