fargo_velocity.c File Reference

Functions for computing/retrieving the mean aziumthal velocity. More...

#include "pluto.h"

Functions
void	FARGO_ComputeVelocity (const Data *d, Grid *grid)
void	FARGO_SubtractVelocity (const Data *d, Grid *grid)
void	FARGO_AddVelocity (const Data *d, Grid *grid)
double **	FARGO_GetVelocity (void)

Variables
static double **	wA

Detailed Description

Collects various functions for computing, adding, subtracting and retrieving the azimuthally-averaged velocity. Depending on the macro FARGO_AVERAGE_VELOCITY (YES/NO) this is done either numerically or analytically.

Authors

A. Mignone (migno.nosp@m.ne@p.nosp@m.h.uni.nosp@m.to.i.nosp@m.t)
G. Muscianisi (g.mus.nosp@m.cian.nosp@m.isi@c.nosp@m.inec.nosp@m.a.it)

Date

Sept 12, 2012

Function Documentation

void FARGO_AddVelocity	(	const Data *	d,
		Grid *	grid
	)

Add the mean backgroun contribution to the residual velocity in order to obtain the total velocity.

Parameters

[in,out]	d	pointer to PLUTO Data structure
[in]	grid	pointer to array of Grid structures

Returns

This function has no return value.

void FARGO_ComputeVelocity	(	const Data *	d,
		Grid *	grid
	)

Compute the mean orbital velocity as a 2D array by averaging for each pair (x,z)/(r,z)/(r,theta) (in Cartesian/polar/spherical) along the orbital coordinate y/phi/phi.

double** FARGO_GetVelocity

(

void

)

Return a pointer to the background orbital velocity wA.

void FARGO_SubtractVelocity	(	const Data *	d,
		Grid *	grid
	)

Subtract the mean background contribution from the total velocity. In other words, compute the residual velocity.

Parameters

[in,out]	d	pointer to PLUTO Data structure
[in]	grid	pointer to array of Grid structures

Returns

This function has no return value.

Variable Documentation

double** wA

static

Defines a 2D array containing the azimuthally-averaged velocity. When the average is done along the X2 direction (Cartesian and polar geometries) the array should have size (NX3_TOT, NX1_TOT). When the average is performed along the X3 direction (spherical geometry) the array has dimensions (NX2_TOT, NX1_TOT)