PLUTO  4.4-patch2
Functions | Variables
fargo_velocity.c File Reference

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

#include "pluto.h"

Functions

void FARGO_Initialize (void)
 
void FARGO_AverageVelocity (const Data *d, Grid *grid)
 
void FARGO_ComputeTotalVelocity (const Data *d, double ***vtot, Grid *grid)
 
void FARGO_ComputeResidualVelocity (const Data *d, double ***vres, Grid *grid)
 
double ** FARGO_Velocity (void)
 

Variables

static double ** wA
 

Detailed Description

Authors
A. Mignone (migno.nosp@m.ne@t.nosp@m.o.inf.nosp@m.n.it)
G. Muscianisi (g.mus.nosp@m.cian.nosp@m.isi@c.nosp@m.inec.nosp@m.a.it)
Date
Apr 15, 2021

Function Documentation

◆ FARGO_AverageVelocity()

void FARGO_AverageVelocity ( const Data d,
Grid grid 
)

Compute the background orbital velocity as a 2D array by averaging the total azimuthal velocity along the orbital coordinate y/phi/phi. Update the residual velocity as well.

◆ FARGO_ComputeResidualVelocity()

void FARGO_ComputeResidualVelocity ( const Data d,
double ***  vres,
Grid grid 
)

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

Parameters
[in]dpointer to PLUTO Data structure. It is assumed that d->Vc[VX2] contains the total vel.
[out]vresarray where the residual velocity is stored. (can be also d->Vc[VX2])
[in]gridpointer to array of Grid structures
Returns
This function has no return value.

◆ FARGO_ComputeTotalVelocity()

void FARGO_ComputeTotalVelocity ( const Data d,
double ***  vtot,
Grid grid 
)

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

Parameters
[in]dpointer to PLUTO Data structure. It is assumed that d->Vc[VX2] contains the residual.
[out]vtotarray where the total velocity is stored. (can be also d->Vc[VX2])
[in]gridpointer to array of Grid structures
Returns
This function has no return value.

◆ FARGO_Initialize()

void FARGO_Initialize ( void  )

Initialize FARGO module.

◆ FARGO_Velocity()

double** FARGO_Velocity ( void  )

Return a pointer to the background orbital velocity wA.

Variable Documentation

◆ wA

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)