Relaxation Runge-Kutta ODE solver base class. More...

#include <rrk_ode_solver_base.h>

Inheritance diagram for PHiLiP::ODE::RRKODESolverBase< dim, real, MeshType >:

Collaboration diagram for PHiLiP::ODE::RRKODESolverBase< dim, real, MeshType >:

Public Member Functions
	RRKODESolverBase (std::shared_ptr< RKTableauBase< dim, real, MeshType >> rk_tableau_input)
	Constructor.

Public Member Functions inherited from PHiLiP::ODE::RKNumEntropy< dim, real, MeshType >
	RKNumEntropy (std::shared_ptr< RKTableauBase< dim, real, MeshType >> rk_tableau_input)
	Default constructor that will set the constants.

real	compute_FR_entropy_contribution (const real dt, std::shared_ptr< DGBase< dim, real, MeshType >> dg, const std::vector< dealii::LinearAlgebra::distributed::Vector< double >> &rk_stage, const bool compute_K_norm) const override
	Calculate FR entropy adjustment. More...

Public Member Functions inherited from PHiLiP::ODE::EmptyRRKBase< dim, real, MeshType >
	EmptyRRKBase (std::shared_ptr< RKTableauBase< dim, real, MeshType >>)
	Default constructor that will set the constants.

Public Attributes
real	relaxation_parameter = 1.0
	Relaxation Runge-Kutta parameter gamma^n. More...

Protected Member Functions
real	update_relaxation_parameter (const real dt, std::shared_ptr< DGBase< dim, real, MeshType >> dg, const std::vector< dealii::LinearAlgebra::distributed::Vector< double >> &rk_stage, const dealii::LinearAlgebra::distributed::Vector< double > &solution_update) override

virtual real	compute_relaxation_parameter (const real dt, std::shared_ptr< DGBase< dim, real, MeshType >> dg, const std::vector< dealii::LinearAlgebra::distributed::Vector< double >> &rk_stage, const dealii::LinearAlgebra::distributed::Vector< double > &)=0

Protected Member Functions inherited from PHiLiP::ODE::RKNumEntropy< dim, real, MeshType >
void	store_stage_solutions (const int istage, const dealii::LinearAlgebra::distributed::Vector< double > rk_stage_i) override
	Update stored quantities at the current stage. More...

dealii::LinearAlgebra::distributed::Vector< double >	compute_entropy_vars (const dealii::LinearAlgebra::distributed::Vector< double > &u, std::shared_ptr< DGBase< dim, real, MeshType >> dg) const
	Return the entropy variables from a solution vector u.

Additional Inherited Members
Protected Attributes inherited from PHiLiP::ODE::RKNumEntropy< dim, real, MeshType >
std::shared_ptr< RKTableauBase< dim, real, MeshType > >	butcher_tableau
	Store pointer to RK tableau.

const int	n_rk_stages
	Number of RK stages.

const MPI_Comm	mpi_communicator
	MPI communicator.

const int	mpi_rank
	MPI rank.

dealii::ConditionalOStream	pcout
	Parallel std::cout that only outputs on mpi_rank==0.

std::vector< dealii::LinearAlgebra::distributed::Vector< double > >	rk_stage_solution
	Storage for the solution at each Runge-Kutta stage. More...

Detailed Description

template<int dim, typename real, typename MeshType = dealii::parallel::distributed::Triangulation<dim>>
class PHiLiP::ODE::RRKODESolverBase< dim, real, MeshType >

Relaxation Runge-Kutta ODE solver base class.

Definition at line 17 of file rrk_ode_solver_base.h.

Member Function Documentation

◆ compute_relaxation_parameter()

template<int dim, typename real , typename MeshType = dealii::parallel::distributed::Triangulation<dim>>

virtual real PHiLiP::ODE::RRKODESolverBase< dim, real, MeshType >::compute_relaxation_parameter	(	const real	dt,
		std::shared_ptr< DGBase< dim, real, MeshType >>	dg,
		const std::vector< dealii::LinearAlgebra::distributed::Vector< double >> &	rk_stage,
		const dealii::LinearAlgebra::distributed::Vector< double > &
	)

protectedpure virtual

Compute relaxation parameter explicitly (i.e. if energy is the entropy variable) See Ketcheson 2019, Eq. 2.4 See Ranocha 2020, Eq. 2.4

Implemented in PHiLiP::ODE::AlgebraicRRKODESolver< dim, real, MeshType >, and PHiLiP::ODE::RootFindingRRKODESolver< dim, real, MeshType >.

◆ update_relaxation_parameter()

template<int dim, typename real , typename MeshType >

real PHiLiP::ODE::RRKODESolverBase< dim, real, MeshType >::update_relaxation_parameter	(	const real	dt,
		std::shared_ptr< DGBase< dim, real, MeshType >>	dg,
		const std::vector< dealii::LinearAlgebra::distributed::Vector< double >> &	rk_stage,
		const dealii::LinearAlgebra::distributed::Vector< double > &	solution_update
	)

overrideprotectedvirtual

Calculate the relaxation parameter at the current time step Calls compute_relaxation_parameter, which updates according to the desired RRK variant

Reimplemented from PHiLiP::ODE::EmptyRRKBase< dim, real, MeshType >.

Definition at line 15 of file rrk_ode_solver_base.cpp.

Member Data Documentation

◆ relaxation_parameter

template<int dim, typename real , typename MeshType = dealii::parallel::distributed::Triangulation<dim>>

real PHiLiP::ODE::RRKODESolverBase< dim, real, MeshType >::relaxation_parameter = 1.0

Relaxation Runge-Kutta parameter gamma^n.

See: Ketcheson 2019, "Relaxation Runge--Kutta methods: Conservation and stability for inner-product norms" Ranocha 2020, "Relaxation Runge--Kutta Methods: Fully Discrete Explicit Entropy-Stable Schemes for the Compressible Euler and Navier--Stokes Equations"

Definition at line 28 of file rrk_ode_solver_base.h.

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

src/ode_solver/relaxation_runge_kutta/rrk_ode_solver_base.h
src/ode_solver/relaxation_runge_kutta/rrk_ode_solver_base.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members