prob/cylfieldloop.c File Reference

Problem generator for advection of a field loop test in cylindrical coordinates. More...

Go to the source code of this file.

Functions
static Real	grav_pot (const Real x1, const Real x2, const Real x3)
	Gravitatioinal potential.
static Real	grav_acc (const Real x1, const Real x2, const Real x3)
	Gravitational acceleration.
Real	M2 (const Real x1, const Real x2, const Real x3)
Real	A3 (const Real x1, const Real x2, const Real x3)
	3-component of vector potential
void	problem (DomainS *pDomain)
	Problem initial conditions, edited for each problem.
void	problem_write_restart (MeshS *pM, FILE *fp)
	Problem specific subroutine for use with writing restart files, Edited for each problem.
void	problem_read_restart (MeshS *pM, FILE *fp)
	Problem specific subroutine for use with reading restart files, Edited for each problem.
ConsFun_t	get_usr_expr (const char *expr)
	Sets pointer to expression for special output data.
VOutFun_t	get_usr_out_fun (const char *name)
	Returns a user defined output function pointer.
void	Userwork_in_loop (MeshS *pM)
	Problem work executed during each step in the main Athena loop, see main.c.
void	Userwork_after_loop (MeshS *pM)
	Problem work executed after the main Athena loop, see main.c Edited for each problem.
Variables
static Real	r0
static Real	phi0
static Real	amp
static Real	rad
static Real	rho0
static Real	omega0
static Real	vz0
static ConsS ***	RootSoln = NULL

---

Detailed Description

Problem generator for advection of a field loop test in cylindrical coordinates.

PURPOSE: Problem generator for advection of a field loop test in cylindrical coordinates. Can only be run in 2D or 3D. Input parameters are:

• problem/r0 = radial coordinate of loop center
• problem/phi0 = angular coordinate of loop center
• problem/rad = radius of field loop
• problem/amp = amplitude of vector potential (and therefore B)
• problem/omega0 = flow angular velocity
• problem/vz0 = flow vertical velocity

REFERENCE: T. Gardiner & J.M. Stone, "An unsplit Godunov method for ideal MHD via constrined transport", JCP, 205, 509 (2005)

Definition in file cylfieldloop.c.

---

Function Documentation

static Real A3	(	const Real	x1,
		const Real	x2,
		const Real	x3
	)

3-component of vector potential

A3: 3-component of vector potential.

Definition at line 215 of file cylfieldloop.c.

References amp, phi0, r0, and rad.

Referenced by Ax(), Ay(), Az(), problem(), vecpot2b1i(), and vecpot2b2i().

Here is the caller graph for this function:

ConsFun_t get_usr_expr

(

const char *

expr

)

Sets pointer to expression for special output data.

Definition at line 173 of file cylfieldloop.c.

VOutFun_t get_usr_out_fun

(

const char *

name

)

Returns a user defined output function pointer.

Definition at line 178 of file cylfieldloop.c.

static Real grav_acc	(	const Real	x1,
		const Real	x2,
		const Real	x3
	)			[static]

Gravitational acceleration.

Definition at line 203 of file cylfieldloop.c.

References omega0.

static Real grav_pot	(	const Real	x1,
		const Real	x2,
		const Real	x3
	)			[static]

Gravitatioinal potential.

Definition at line 197 of file cylfieldloop.c.

References omega0.

Real M2	(	const Real	x1,
		const Real	x2,
		const Real	x3
	)

Definition at line 209 of file cylfieldloop.c.

References omega0, and rho0.

void problem

(

DomainS *

pDomain

)

Problem initial conditions, edited for each problem.

Definition at line 47 of file cylfieldloop.c.

References A3(), amp, ath_error(), avg1d(), ConsS::B1c, GridS::B1i, ConsS::B2c, GridS::B2i, ConsS::B3c, GridS::B3i, bvals_mhd_fun(), calloc_3d_array(), cc_pos(), compute_div_b(), ConsS::d, do_nothing_bc(), GridS::dx1, ConsS::E, Gamma_1, DomainS::Grid, GridS::ie, il, GridS::is, iu, GridS::je, jl, GridS::js, ju, GridS::ke, kl, GridS::ks, ku, left_x1, ConsS::M1, M2(), ConsS::M2, ConsS::M3, nx1, nx2, nx3, omega0, par_getd(), phi0, r0, rad, rho0, right_x1, StaticGravPot, GridS::U, vecpot2b1i(), vecpot2b2i(), vz0, and x1GravAcc.

Here is the call graph for this function:

void problem_read_restart	(	MeshS *	pM,
		FILE *	fp
	)

Problem specific subroutine for use with reading restart files, Edited for each problem.

Definition at line 168 of file cylfieldloop.c.

void problem_write_restart	(	MeshS *	pM,
		FILE *	fp
	)

Problem specific subroutine for use with writing restart files, Edited for each problem.

Definition at line 163 of file cylfieldloop.c.

void Userwork_after_loop

(

MeshS *

pM

)

Problem work executed after the main Athena loop, see main.c Edited for each problem.

Definition at line 187 of file cylfieldloop.c.

References compute_l1_error().

Here is the call graph for this function:

void Userwork_in_loop

(

MeshS *

pM

)

Problem work executed during each step in the main Athena loop, see main.c.

Edited for each problem.

Definition at line 182 of file cylfieldloop.c.

References compute_div_b(), MeshS::Domain, and DomainS::Grid.

Here is the call graph for this function:

---

Variable Documentation

Real amp [static]

Definition at line 37 of file cylfieldloop.c.

Real omega0 [static]

Definition at line 37 of file cylfieldloop.c.

Referenced by grav_acc(), grav_pot(), M2(), and problem().

Real phi0 [static]

Definition at line 37 of file cylfieldloop.c.

Referenced by A3(), and problem().

Real r0 [static]

Definition at line 37 of file cylfieldloop.c.

Referenced by A3(), problem(), and Userwork_in_loop().

Real rad [static]

Definition at line 37 of file cylfieldloop.c.

Referenced by A3(), and problem().

Real rho0 [static]

Definition at line 37 of file cylfieldloop.c.

ConsS*** RootSoln = NULL [static]

Definition at line 42 of file cylfieldloop.c.

Real vz0 [static]

Definition at line 37 of file cylfieldloop.c.

Referenced by problem().