Classes | Typedefs | Enumerations

athena.h File Reference

Contains definitions of many data types and structures. More...

Go to the source code of this file.

Classes

struct  Real3Vect
 General 3-vectors of Reals. More...
struct  Int3Vect
 General 3-vectors of ints. More...
struct  SideS
 Sides of a cube, used to find overlaps between Grids at different levels. More...
struct  GridsDataS
 Number of zones in, and identifying information about, a Grid. More...
struct  ConsS
 Conserved variables. More...
struct  PrimS
 Primitive variables. More...
struct  Cons1DS
 Conserved variables in 1D (does not contain Bx). More...
struct  Prim1DS
 Primitive variables in 1D (does not contain Bx). More...
struct  GrainS
 Basic quantities for one pseudo-particle. More...
struct  GrainAux
 Auxilary quantities for a dust particle. More...
struct  Grain_Property
 List of physical grain properties. More...
struct  GPCouple
 Grid elements for gas-particle coupling. More...
struct  GridOvrlpS
 Contains information about Grid overlaps, used for SMR. More...
struct  GridS
 3D arrays of dependent variables, plus grid data, plus particle data, plus data about child and parent Grids, plus MPI rank information for a Grid. More...
struct  DomainS
 Information about one region of Mesh at some particular level. More...
struct  MeshS
 Information about entire mesh hierarchy, including array of Domains. More...
struct  OutputS
 Everything for outputs. More...

Typedefs

typedef float Real
 Variable precision float, depends on macro set by configure.
typedef void(* VGFun_t )(GridS *pG)
 Generic void function of Grid.
typedef void(* VDFun_t )(DomainS *pD)
 Generic void function of Domain.
typedef void(* VOutFun_t )(MeshS *pM, struct Output_s *pout)
 Output function pointer.
typedef void(* VResFun_t )(MeshS *pM, struct Output_s *pout)
 Restart function pointer.
typedef Real(* ConsFun_t )(const GridS *pG, const int i, const int j, const int k)
 Pointer to expression that computes quant for output.
typedef int(* PropFun_t )(const Grain *gr, const GrainAux *grsub)
 Particle property selection function.
typedef Real(* Parfun_t )(const Grid *pG, const Grain *gr)
typedef Real(* GravPotFun_t )(const Real x1, const Real x2, const Real x3)
 Gravitational potential function.
typedef Real(* StaticGravAcc_t )(const Real x1, const Real x2, const Real x3)
 Static gravitational acceleration.
typedef Real(* OrbitalFun_t )(const Real x1)
 Orbital function for FARGO.
typedef Real(* ShearFun_t )(const Real x1)
 Shear function for FARGO.
typedef Real(* CoolingFun_t )(const Real d, const Real p, const Real dt)
 Cooling function.
typedef void(* EtaFun_t )(GridS *pG, int i, int j, int k, Real *eta_O, Real *eta_H, Real *eta_A)
 Resistivity Eta Function.
typedef void(* WeightFun_t )(GridS *pG, Real x1, Real x2, Real x3, Real3Vector cell1, Real weight[3][3][3], int *is, int *js, int *ks)
 Interpolation scheme for particles.
typedef Real(* TSFun_t )(GridS *pG, int type, Real rho, Real cs, Real vd)
 Stopping time function for particles.

Enumerations

enum  BCDirection {
  left_x1, right_x1, left_x2, right_x2,
  left_x3, right_x3
}
 

Directions for the set_bvals_fun() function.

More...

Detailed Description

Contains definitions of many data types and structures.

PURPOSE: Contains definitions of the following data types and structures:

Definition in file athena.h.


Typedef Documentation

Real(* ConsFun_t)(const GridS *pG, const int i, const int j, const int k)

Pointer to expression that computes quant for output.

Definition at line 401 of file athena.h.

Real(* CoolingFun_t)(const Real d, const Real p, const Real dt)

Cooling function.

Definition at line 481 of file athena.h.

void(* EtaFun_t)(GridS *pG, int i, int j, int k, Real *eta_O, Real *eta_H, Real *eta_A)

Resistivity Eta Function.

Definition at line 486 of file athena.h.

Real(* GravPotFun_t)(const Real x1, const Real x2, const Real x3)

Gravitational potential function.

Definition at line 465 of file athena.h.

Real(* OrbitalFun_t)(const Real x1)

Orbital function for FARGO.

Definition at line 473 of file athena.h.

typedef Real(* Parfun_t)(const Grid *pG, const Grain *gr)

Definition at line 406 of file athena.h.

int(* PropFun_t)(const Grain *gr, const GrainAux *grsub)

Particle property selection function.

Definition at line 405 of file athena.h.

typedef double Real

Variable precision float, depends on macro set by configure.

Definition at line 32 of file athena.h.

Real(* ShearFun_t)(const Real x1)

Shear function for FARGO.

Definition at line 476 of file athena.h.

Real(* StaticGravAcc_t)(const Real x1, const Real x2, const Real x3)

Static gravitational acceleration.

Definition at line 469 of file athena.h.

Real(* TSFun_t)(GridS *pG, int type, Real rho, Real cs, Real vd)

Stopping time function for particles.

Definition at line 499 of file athena.h.

void(* VDFun_t)(DomainS *pD)

Generic void function of Domain.

Definition at line 366 of file athena.h.

void(* VGFun_t)(GridS *pG)

Generic void function of Grid.

Definition at line 322 of file athena.h.

void(* VOutFun_t)(MeshS *pM, struct Output_s *pout)

Output function pointer.

Definition at line 395 of file athena.h.

void(* VResFun_t)(MeshS *pM, struct Output_s *pout)

Restart function pointer.

Definition at line 398 of file athena.h.

void(* WeightFun_t)(GridS *pG, Real x1, Real x2, Real x3, Real3Vector cell1, Real weight[3][3][3], int *is, int *js, int *ks)

Interpolation scheme for particles.

Definition at line 495 of file athena.h.


Enumeration Type Documentation

Directions for the set_bvals_fun() function.

Enumerator:
left_x1 
right_x1 
left_x2 
right_x2 
left_x3 
right_x3 

Definition at line 505 of file athena.h.