ldz_hall.hpp File Reference

#include "../definitions.h"

Include dependency graph for ldz_hall.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	calculateHallTermSimple (fsgrids::perbspan perb, fsgrids::perbspan perbdt2, fsgrids::ehallspan ehall, fsgrids::momentsspan moments, fsgrids::momentsspan momentsdt2, fsgrids::dperbspan dperb, fsgrids::dmomentsspan dmoments, fsgrids::dmomentsspan dmomentsdt2, fsgrids::bgbspan bgb, fsgrids::technicalspan technical, FieldSolverGrid &fsgrid, SysBoundary &sysBoundaries, int32_t RKCase, const bool communicateMomentsDerivatives)
	High-level function computing the Hall term.

Function Documentation

calculateHallTermSimple()

void calculateHallTermSimple	(	fsgrids::perbspan	perb,
		fsgrids::perbspan	perbdt2,
		fsgrids::ehallspan	ehall,
		fsgrids::momentsspan	moments,
		fsgrids::momentsspan	momentsdt2,
		fsgrids::dperbspan	dperb,
		fsgrids::dmomentsspan	dmoments,
		fsgrids::dmomentsspan	dmomentsdt2,
		fsgrids::bgbspan	bgb,
		fsgrids::technicalspan	technical,
		FieldSolverGrid &	fsgrid,
		SysBoundary &	sysBoundaries,
		int32_t	RKCase,
		const bool	communicateMomentsDerivatives )

High-level function computing the Hall term.

Performs the communication before and after the computation as well as the computation of all Hall term numerator components.

Parameters

perb	fsGrid holding the perturbed B quantities
perbdt2	fsGrid holding the perturbed B quantities at runge-kutta half step
ehall	fsGrid holding the Hall contributions to the electric field
moments	fsGrid holding the moment quantities
momentsdt2	fsGrid holding the moment quantities at runge-kutta half step
dperb	fsGrid holding the derivatives of perturbed B
dmoments	fsGrid holding the derivatives of moments
dmomentsdt2	fsGrid holding the derivatives of moments at Runge-Kutta half step
bgb	fsGrid holding the background B quantities
technical	fsGrid holding technical information (such as boundary types)
fsgrid	fsgrids container
sysBoundaries	System boundary condition functions.
RKCase	Element in the enum defining the Runge-Kutta method steps
communicateMomentsDerivatives	Boolean flag whether to ghost update moments derivatives

See also

calculateHallTerm

Definition at line 1120 of file ldz_hall.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: