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

Navier-Stokes equation of motion. More...

#include <EquationTerm.h>

Inheritance diagram for NavierStokesForce:
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 &scheduler, Storage &storage, const Float t) override
 Initialize all the derivatives and/or quantity values before derivatives are computed. More...
 
virtual void finalize (IScheduler &scheduler, Storage &storage, const Float t) override
 Computes all the derivatives and/or quantity values based on accumulated derivatives. More...
 
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 Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Navier-Stokes equation of motion.

Todo:

Definition at line 168 of file EquationTerm.h.

Member Function Documentation

◆ create()

void NavierStokesForce::create ( Storage storage,
IMaterial material 
) const
overridevirtual

Creates all quantities needed by the term using given material.

Called once for every body in the simulation.

Implements IEquationTerm.

Definition at line 254 of file EquationTerm.cpp.

◆ finalize()

void NavierStokesForce::finalize ( IScheduler scheduler,
Storage storage,
const Float  t 
)
overridevirtual

Computes all the derivatives and/or quantity values based on accumulated derivatives.

Called every time step after derivatives are evaluated and saved to storage.

Todo:
rotation rate tensor?

Implements IEquationTerm.

Definition at line 233 of file EquationTerm.cpp.

◆ initialize()

void NavierStokesForce::initialize ( IScheduler scheduler,
Storage storage,
const Float  t 
)
overridevirtual

Initialize all the derivatives and/or quantity values before derivatives are computed.

Called at the beginning of every time step. Note that derivatives need not be zeroed out manually, this is already done by timestepping (for derivatives of quantities) and solver (for accumulated values).

Implements IEquationTerm.

Definition at line 227 of file EquationTerm.cpp.

◆ setDerivatives()

void NavierStokesForce::setDerivatives ( DerivativeHolder derivatives,
const RunSettings settings 
)
overridevirtual

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.

derivatives.require<StressDivergence>(derivatives, settings);

Implements IEquationTerm.

Definition at line 220 of file EquationTerm.cpp.


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