Basilisk CFD
Adaptive Cartesian mesh PDE framework
Loading...
Searching...
No Matches
common.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  realtype_1d
 

Macros

#define gotm_nlev   __gotm_MOD_nlev
 
#define gotm_dt   __gotm_MOD_dt
 
#define gotm_cnpar   __gotm_MOD_cnpar
 
#define gotm_buoy_method   __gotm_MOD_buoy_method
 
#define airsea_tx   __airsea_MOD_tx
 
#define airsea_ty   __airsea_MOD_ty
 
#define airsea_evap   __airsea_MOD_evap
 
#define time_unixseconds()
 

Typedefs

typedef int integer
 
typedef int logical
 
typedef double realtype
 
typedef long timestepkind
 

Functions

int strlencheck (const char *s)
 

Variables

integer __gotm_MOD_nlev
 
realtype __gotm_MOD_dt
 
realtype __gotm_MOD_cnpar
 
integer __gotm_MOD_buoy_method
 

Macro Definition Documentation

◆ airsea_evap

#define airsea_evap   __airsea_MOD_evap

Definition at line 68 of file common.h.

◆ airsea_tx

#define airsea_tx   __airsea_MOD_tx

Definition at line 66 of file common.h.

◆ airsea_ty

#define airsea_ty   __airsea_MOD_ty

Definition at line 67 of file common.h.

◆ gotm_buoy_method

#define gotm_buoy_method   __gotm_MOD_buoy_method

Definition at line 64 of file common.h.

◆ gotm_cnpar

#define gotm_cnpar   __gotm_MOD_cnpar

Definition at line 62 of file common.h.

◆ gotm_dt

#define gotm_dt   __gotm_MOD_dt

Definition at line 60 of file common.h.

◆ gotm_nlev

#define gotm_nlev   __gotm_MOD_nlev

Definition at line 58 of file common.h.

◆ time_unixseconds

#define time_unixseconds ( )
Value:
((long)((time_julianday - 2440587.5)*86400. + \
int x
Definition common.h:76
#define time_julianday
Definition time.h:20
#define time_secondsofday
Definition time.h:22

Definition at line 70 of file common.h.

Typedef Documentation

◆ integer

A C interface to the General Ocean Turbulence Model (GOTM)

GOTM is a library implementing a large number of turbulence models and auxilliary functions adapted to the description of vertical mixing in ocean models.

This file and other files in this folder provide the C functions definitions which can be used to call the corresponding Fortran functions in the GOTM libraries.

Note that these files are entirely independent from Basilisk.

All the header files (except this one) were generated automatically from the Fortran 90 source code of GOTM (stable version 5.2.1). The [Makefile]() provided can be used to regenerate them if necessary.

Installation of GOTM

The GOTM libraries must be installed separately. Only version 5.2.1 is supported at the moment. A patch must be applied before compilation.

See the GOTM installation instructions for details but otherwise follow this recipe:

sudo apt install libnetcdff-dev
wget https://github.com/gotm-model/code/archive/v5.2.1.tar.gz
tar xzvf v5.2.1.tar.gz
cd code-5.2.1/src
wget https://basilisk.fr/src/gotm/gotm.patch?raw -O gotm.patch
patch -p0 < gotm.patch
cd ..
mkdir build
cd build
cmake ../src -DGOTM_USE_FABM=off
make

Definition at line 45 of file common.h.

◆ logical

Definition at line 46 of file common.h.

◆ realtype

Definition at line 47 of file common.h.

◆ timestepkind

Definition at line 48 of file common.h.

Function Documentation

◆ strlencheck()

int strlencheck ( const char s)

Definition at line 53 of file common.h.

References s, and x.

Variable Documentation

◆ __gotm_MOD_buoy_method

integer __gotm_MOD_buoy_method
extern

◆ __gotm_MOD_cnpar

realtype __gotm_MOD_cnpar
extern

◆ __gotm_MOD_dt

realtype __gotm_MOD_dt
extern

◆ __gotm_MOD_nlev

integer __gotm_MOD_nlev
extern