Athena: prob/planet-disk.c File Reference

Problem generator for planet embedded in a disk, using the shearing sheet approximation. More...

Go to the source code of this file.

Functions
void	constant_iib (GridS *pGrid)
	Sets boundary condition on left X boundary (iib) to constant state (initial values).
void	constant_oib (GridS *pGrid)
	Sets boundary condition on right X boundary (oib) to constant state (initial values).
static Real	PlanetPot (const Real x1, const Real x2, const Real x3)
	static gravitational potential of planet
static Real	UnstratifiedDisk (const Real x1, const Real x2, const Real x3)
static Real	expr_dV2 (const GridS *pG, const int i, const int j, const int k)
	Computes delta(Vy).
static Real	hst_rho_Vx_dVy (const GridS *pG, const int i, const int j, const int k)
	Reynolds stress, added as history variable.
static Real	hst_rho_dVy2 (const GridS *pG, const int i, const int j, const int k)
	KE in y-velocity fluctuations.
static Real	hst_E_total (const GridS *pG, const int i, const int j, const int k)
	total energy (including tidal 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	Mp
static Real	Rsoft
static Real	Xplanet
static Real	Yplanet
static Real	Zplanet
static Real	ramp_time
static Real	insert_time

Detailed Description

Problem generator for planet embedded in a disk, using the shearing sheet approximation.

Code must be configured using --enable-shearing-box

Definition in file planet-disk.c.

Function Documentation

void constant_iib ( GridS * pGrid )

Sets boundary condition on left X boundary (iib) to constant state (initial values).

Definition at line 335 of file planet-disk.c.

References cc_pos(), ConsS::d, ConsS::E, Gamma_1, GridS::is, GridS::je, GridS::js, GridS::ke, GridS::ks, ConsS::M1, ConsS::M2, ConsS::M3, Omega_0, qshear, and GridS::U.

Referenced by problem(), and problem_read_restart().

Here is the call graph for this function:

Here is the caller graph for this function:

void constant_oib ( GridS * pGrid )

Sets boundary condition on right X boundary (oib) to constant state (initial values).

Definition at line 376 of file planet-disk.c.

References cc_pos(), ConsS::d, ConsS::E, Gamma_1, GridS::ie, GridS::is, GridS::je, GridS::js, GridS::ke, GridS::ks, ConsS::M1, ConsS::M2, ConsS::M3, Omega_0, qshear, and GridS::U.

Referenced by problem(), and problem_read_restart().

Here is the call graph for this function:

Here is the caller graph for this function:

static Real expr_dV2	(	const GridS *	pG,
		const int	i,
		const int	j,
		const int	k
	)			`[static]`

Computes delta(Vy).

Definition at line 261 of file planet-disk.c.

References cc_pos(), ConsS::d, ConsS::M2, Omega_0, qshear, and GridS::U.

Here is the call graph for this function:

ConsFun_t get_usr_expr ( const char * expr )

Sets pointer to expression for special output data.

Definition at line 207 of file planet-disk.c.

VOutFun_t get_usr_out_fun ( const char * name )

Returns a user defined output function pointer.

Definition at line 213 of file planet-disk.c.

static Real hst_E_total	(	const GridS *	pG,
		const int	i,
		const int	j,
		const int	k
	)			`[static]`

total energy (including tidal potential).

Definition at line 319 of file planet-disk.c.

References cc_pos(), ConsS::d, ConsS::E, GridS::U, and UnstratifiedDisk().

Referenced by problem(), and problem_read_restart().

Here is the call graph for this function:

Here is the caller graph for this function:

static Real hst_rho_dVy2	(	const GridS *	pG,
		const int	i,
		const int	j,
		const int	k
	)			`[static]`

KE in y-velocity fluctuations.

Definition at line 301 of file planet-disk.c.

References cc_pos(), ConsS::d, ConsS::M2, Omega_0, qshear, and GridS::U.

Referenced by problem(), and problem_read_restart().

Here is the call graph for this function:

Here is the caller graph for this function:

static Real hst_rho_Vx_dVy	(	const GridS *	pG,
		const int	i,
		const int	j,
		const int	k
	)			`[static]`

Reynolds stress, added as history variable.

Definition at line 284 of file planet-disk.c.

References cc_pos(), ConsS::d, ConsS::M1, ConsS::M2, Omega_0, qshear, and GridS::U.

Referenced by problem(), and problem_read_restart().

Here is the call graph for this function:

Here is the caller graph for this function:

static Real PlanetPot	(	const Real	x1,
		const Real	x2,
		const Real	x3
	)			`[static]`

static gravitational potential of planet

Definition at line 231 of file planet-disk.c.

References insert_time, Mp, rad, ramp_time, Rsoft, Xplanet, Yplanet, and Zplanet.

void problem ( DomainS * pDomain )

Problem initial conditions, edited for each problem.

Definition at line 44 of file planet-disk.c.

References bvals_mhd_fun(), cc_pos(), constant_iib(), constant_oib(), ConsS::d, DomainS::Disp, dump_history_enroll(), ConsS::E, Gamma_1, DomainS::Grid, hst_E_total(), hst_rho_dVy2(), hst_rho_Vx_dVy(), GridS::ie, insert_time, GridS::is, Iso_csound2, GridS::je, GridS::js, GridS::ke, GridS::ks, left_x1, ConsS::M1, ConsS::M2, ConsS::M3, DomainS::MaxX, Mp, Omega_0, par_getd(), par_getd_def(), par_geti_def(), qshear, ramp_time, right_x1, DomainS::RootMaxX, Rsoft, ShBoxCoord, ShearingBoxPot, StaticGravPot, GridS::U, Xplanet, Yplanet, and Zplanet.

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 158 of file planet-disk.c.

References bvals_mhd_fun(), constant_iib(), constant_oib(), DomainS::Disp, MeshS::Domain, MeshS::DomainsPerLevel, dump_history_enroll(), hst_E_total(), hst_rho_dVy2(), hst_rho_Vx_dVy(), insert_time, left_x1, DomainS::MaxX, Mp, MeshS::NLevels, Omega_0, par_getd(), par_getd_def(), par_geti_def(), qshear, ramp_time, right_x1, DomainS::RootMaxX, Rsoft, ShearingBoxPot, StaticGravPot, Xplanet, Yplanet, and Zplanet.

Here is the call graph for this function:

void problem_write_restart	(	MeshS *	pM,
		FILE *	fp
	)

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

Definition at line 151 of file planet-disk.c.

static Real UnstratifiedDisk	(	const Real	x1,
		const Real	x2,
		const Real	x3
	)			`[static]`

Definition at line 244 of file planet-disk.c.

References Omega_0, and qshear.

Referenced by hst_E_total().

Here is the caller graph for this function:

void Userwork_after_loop ( MeshS * pM )

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

Definition at line 222 of file planet-disk.c.

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 217 of file planet-disk.c.

References ramp_time, and MeshS::time.

Variable Documentation

Real insert_time [static]

Definition at line 31 of file planet-disk.c.

Referenced by PlanetPot(), problem(), and problem_read_restart().

Real Mp [static]

Definition at line 30 of file planet-disk.c.

Referenced by PlanetPot(), problem(), and problem_read_restart().

Real ramp_time [static]

Definition at line 31 of file planet-disk.c.

Referenced by PlanetPot(), problem(), problem_read_restart(), and Userwork_in_loop().

Real Rsoft [static]

Definition at line 30 of file planet-disk.c.

Referenced by PlanetPot(), problem(), and problem_read_restart().

Real Xplanet [static]

Definition at line 30 of file planet-disk.c.

Referenced by PlanetPot(), problem(), and problem_read_restart().

Real Yplanet [static]

Definition at line 30 of file planet-disk.c.

Referenced by PlanetPot(), problem(), and problem_read_restart().

Real Zplanet [static]

Definition at line 30 of file planet-disk.c.

Referenced by PlanetPot(), problem(), and problem_read_restart().