amrex::SundialsUserData Struct Reference

User-supplied callbacks consumed by the AMReX/SUNDIALS bridge. More...

#include <AMReX_SundialsIntegrator.H>

Public Attributes
std::function< int(amrex::Real, N_Vector, N_Vector, void *)>	f
	ERK/DIRK RHS or MRI slow RHS.
std::function< int(amrex::Real, N_Vector, N_Vector, void *)>	fi
	Implicit RHS for ImEx schemes.
std::function< int(amrex::Real, N_Vector, N_Vector, void *)>	fe
	Explicit RHS for ImEx schemes.
std::function< int(amrex::Real, N_Vector, N_Vector, void *)>	ff
	MRI fast-scale RHS.
std::function< int(amrex::Real, N_Vector, void *)>	post_stage
	Hook invoked after each stage.
std::function< int(amrex::Real, N_Vector, void *)>	post_step
	Hook invoked after each time step.
std::function< int(amrex::Real, N_Vector, void *)>	post_fast_stage
	Hook for MRI fast stages.
std::function< int(amrex::Real, N_Vector, void *)>	post_fast_step
	Hook for MRI fast steps.

Detailed Description

User-supplied callbacks consumed by the AMReX/SUNDIALS bridge.

Each functor must implement the signatures noted below and follow the SUNDIALS convention of returning 0 on success and non-zero on failure.

Member Data Documentation

f

std::function<int(amrex::Real, N_Vector, N_Vector, void*)> amrex::SundialsUserData::f

ERK/DIRK RHS or MRI slow RHS.

fe

std::function<int(amrex::Real, N_Vector, N_Vector, void*)> amrex::SundialsUserData::fe

Explicit RHS for ImEx schemes.

ff

std::function<int(amrex::Real, N_Vector, N_Vector, void*)> amrex::SundialsUserData::ff

MRI fast-scale RHS.

fi

std::function<int(amrex::Real, N_Vector, N_Vector, void*)> amrex::SundialsUserData::fi

Implicit RHS for ImEx schemes.

post_fast_stage

std::function<int(amrex::Real, N_Vector, void*)> amrex::SundialsUserData::post_fast_stage

Hook for MRI fast stages.

post_fast_step

std::function<int(amrex::Real, N_Vector, void*)> amrex::SundialsUserData::post_fast_step

Hook for MRI fast steps.

post_stage

std::function<int(amrex::Real, N_Vector, void*)> amrex::SundialsUserData::post_stage

Hook invoked after each stage.

post_step

std::function<int(amrex::Real, N_Vector, void*)> amrex::SundialsUserData::post_step

Hook invoked after each time step.

---

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

• /home/runner/work/amrex/amrex/Src/Extern/SUNDIALS/AMReX_SundialsIntegrator.H