types.h File Reference

Definition of the structures used in the FARGO code. More...

#include <sys/times.h>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pair
	Set of two reals. More...
struct	polargrid
	A structure used to store any scalar fied on the computational domain. More...
struct	param
	The Param structure handles the parameters of the parameter file. More...
struct	timeprocess
	This structure is used for monitoring CPU time usage. More...
struct	planetary_system
	Contains all the information about a planetary system at a given instant in time. More...

Macros
#define	YES   1
#define	NO   0
#define	REAL   1
#define	INT   0
#define	STRING   2
#define	SINE   0
#define	COSINE   1
#define	ABSCISSA   0
#define	ORDINATE   1
#define	HEIGHT   2
#define	INF   0
#define	SUP   1
#define	GET   0
#define	MARK   1
#define	FREQUENCY   2
#define	COM_DENSITY   0
#define	COM_VRAD   1
#define	COM_VTHETA   2
#define	MAX1D   16384
#define	MAXPLANETS   10

Typedefs
typedef int	boolean
	The boolean type will be used mainly for the variables corresponding to the command line switches. More...
typedef double	real
	Definition of the type 'real' used throughout the code. More...
typedef struct pair	Pair
typedef struct polargrid	PolarGrid
typedef struct param	Param
typedef struct timeprocess	TimeProcess
typedef struct planetary_system	PlanetarySystem

Detailed Description

Definition of the structures used in the FARGO code.

Author

THORIN modifications by Ondřej Chrenko chren.nosp@m.ko@s.nosp@m.irrah.nosp@m..tro.nosp@m.ja.mf.nosp@m.f.cu.nosp@m.ni.cz, Copyright (C) 2017; original code by Frédéric Masset

Definition in file types.h.

Macro Definition Documentation

#define ABSCISSA   0

Definition at line 53 of file types.h.

#define COM_DENSITY   0

Definition at line 61 of file types.h.

#define COM_VRAD   1

Definition at line 62 of file types.h.

#define COM_VTHETA   2

Definition at line 63 of file types.h.

#define COSINE   1

Definition at line 52 of file types.h.

#define FREQUENCY   2

Definition at line 60 of file types.h.

Referenced by GetPsysInfo(), GetPsysInfoFromRsim(), and main().

#define GET   0

Definition at line 58 of file types.h.

Referenced by AlgoGas(), GetPsysInfo(), and GetPsysInfoFromRsim().

#define HEIGHT   2

Definition at line 55 of file types.h.

#define INF   0

Definition at line 56 of file types.h.

#define INT   0

Definition at line 49 of file types.h.

Referenced by InitVariables(), ReadVariables(), and var().

#define MARK   1

Definition at line 59 of file types.h.

Referenced by AlgoGas(), GetPsysInfo(), and GetPsysInfoFromRsim().

#define MAX1D   16384

Definition at line 65 of file types.h.

Referenced by ConditionCFL(), CreateTorqueMapInfile(), MakeDir(), and UpdateLog().

#define MAXPLANETS   10

Definition at line 67 of file types.h.

Referenced by FillForcesArrays().

#define NO   0

Definition at line 47 of file types.h.

Referenced by AdvanceSystemFromDisk(), AlgoGas(), CheckRebin(), DetectCrash(), DiscardParticlesDist(), FillForcesArrays(), GiveSpecificTime(), GiveTimeInfo(), ImplicitRadiativeDiffusion(), InitPlanetarySystem(), InitSpecificTime(), InitVariables(), IterateRelaxationParameter(), main(), merge(), OpacityProfile(), ReadVariables(), SendOutput(), SuccessiveOverrelaxation(), SynchronizeFargoRebound(), SynchronizeOverlapFields(), and var().

#define ORDINATE   1

Definition at line 54 of file types.h.

#define REAL   1

Definition at line 48 of file types.h.

Referenced by InitVariables(), ReadVariables(), and var().

#define SINE   0

Definition at line 51 of file types.h.

#define STRING   2

Definition at line 50 of file types.h.

Referenced by InitVariables(), ReadVariables(), and var().

#define SUP   1

Definition at line 57 of file types.h.

#define YES   1

Definition at line 46 of file types.h.

Referenced by AccreteOntoPlanets(), AdvanceSystemFromDisk(), AlgoGas(), AllocateComm(), AllocPlanetSystem(), ApplyBoundaryCondition(), CheckRebin(), CommunicateBoundaries(), ComputeResiduals(), ConditionCFL(), DetectCrash(), DiscardParticlesDist(), FillForcesArrays(), FillPolar1DArrays(), GetPsysInfo(), GetPsysInfoFromRsim(), GiveTimeInfo(), ImplicitRadiativeDiffusion(), InitPlanetarySystem(), InitVariables(), IterateRelaxationParameter(), ListPlanets(), main(), merge(), OneWindRad(), OneWindTheta(), OneWindThetaPebbles(), OpacityProfile(), QuantitiesAdvection(), ReadVariables(), RestartReboundSimulation(), SendOutput(), SetupIntegratorParams(), SetupReboundSimulation(), SplitDomain(), SuccessiveOverrelaxation(), SynchronizeFargoRebound(), SynchronizeOverlapFields(), TellEverything(), Transport(), and VanLeerRadial().

Typedef Documentation

typedef int boolean

The boolean type will be used mainly for the variables corresponding to the command line switches.

Definition at line 15 of file types.h.

typedef struct pair Pair

Definition at line 31 of file types.h.

typedef struct param Param

Definition at line 82 of file types.h.

typedef struct planetary_system PlanetarySystem

Definition at line 115 of file types.h.

typedef struct polargrid PolarGrid

Definition at line 44 of file types.h.

typedef double real

Definition of the type 'real' used throughout the code.

You can force FARGO to work in single precision by redefining real to float here. This is an untested feature of FARGO, however, and in practice it should be of little use.

Definition at line 20 of file types.h.

typedef struct timeprocess TimeProcess

Definition at line 91 of file types.h.