ablate::solver::RHSFunction Class Reference

Inheritance diagram for ablate::solver::RHSFunction:

Public Member Functions
virtual PetscErrorCode	ComputeRHSFunction (PetscReal time, Vec locX, Vec F)=0
virtual PetscErrorCode	PreRHSFunction (TS ts, PetscReal time, bool initialStage, Vec locX)

Member Function Documentation

ComputeRHSFunction()

virtual PetscErrorCode ablate::solver::RHSFunction::ComputeRHSFunction ( PetscReal  time, Vec  locX, Vec  F  )

pure virtual

Called to compute the RHS source term.

Parameters

time
locX	The locX vector includes boundary conditions
F

Returns

Implemented in ablate::radiation::VolumeRadiation, ablate::finiteVolume::FiniteVolumeSolver, ablate::boundarySolver::DebugBoundarySolver, ablate::boundarySolver::BoundarySolver, and ablate::particles::CoupledParticleSolver.

PreRHSFunction()

virtual PetscErrorCode ablate::solver::RHSFunction::PreRHSFunction ( TS  ts, PetscReal  time, bool  initialStage, Vec  locX  )

inlinevirtual

Called before the RHS function for all solvers

Parameters

time
locX

Returns

Reimplemented in ablate::radiation::VolumeRadiation, ablate::particles::CoupledParticleSolver, ablate::finiteVolume::FiniteVolumeSolver, and ablate::boundarySolver::BoundarySolver.

---

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

• src/solver/rhsFunction.hpp