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

#include <Heat.h>

Inheritance diagram for HeatDiffusionEquation:
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 &storage, const Float UNUSED(t)) override
 
virtual void create (Storage &storage, IMaterial &material) const override
 Creates all quantities needed by the term using given material. More...
 
- 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...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Todo:
this

Definition at line 50 of file Heat.h.

Member Function Documentation

◆ create()

virtual void HeatDiffusionEquation::create ( Storage storage,
IMaterial material 
) const
inlineoverridevirtual

Creates all quantities needed by the term using given material.

Called once for every body in the simulation.

Implements IEquationTerm.

Definition at line 73 of file Heat.h.

◆ finalize()

virtual void HeatDiffusionEquation::finalize ( IScheduler UNUSEDscheduler,
Storage storage,
const Float   UNUSED
)
inlineoverridevirtual

Definition at line 61 of file Heat.h.

◆ initialize()

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

Definition at line 57 of file Heat.h.

◆ setDerivatives()

virtual void HeatDiffusionEquation::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 52 of file Heat.h.


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