ScalarBase adds an interface to include scalar fields within the Einstein Toolkit framework. In the same spirit as ADMBase and HydroBase, this thorn merely stores the variables used in typical scalar field evolutions as well as commonly needed parameters. This thorn was primarily designed to work with the ScalarEvolve thorn, but in principle any other scalar field evolution code could be used.
This thorn defines a set of variables and parameters commonly needed to evolve (complex) scalar fields, potentially coupled to the Einstein field equations. Currently it defines the gridfunctions phi1 and phi2, as well as their “conjugated momenta” Kphi1 and Kphi2. It also declares the parameter mu, the scalar field mass.
This thorn is designed to interface with the evolution thorn ScalarEvolve, but any other scalar evolution code should also work. Within ScalarEvolve, the variables phi1 and phi2 represent the real and imaginary parts of some complex scalar field \(\Phi \), satisfying the Einstein-Klein-Gordon system \begin {align} G_{\mu \nu } & = 8 \pi G T_{\mu \nu } \\ \square \Phi & = \mu ^2 \Phi \end {align}
where \(\mu \) is the mass parameter (denoted by mu in param.ccl) and \begin {equation} T_{\mu \nu } = \bar \Phi _{,\mu } \Phi _{,\nu } + \Phi _{,\mu } \bar \Phi _{,\nu } - g_{\mu \nu } [ \bar \Phi ^{,\sigma } \Phi _{,\sigma } + \mu ^2 \bar \Phi \Phi ] \end {equation}
This thorn is included in the Einstein Toolkit and can also be obtained through the Canuda numerical relativity library [1].
[1] H. Witek, M. Zilhao, G. Bozzola, C.-H. Cheng, A. Dima, M. Elley, G. Ficarra, T. Ikeda, R. Luna, C. Richards, N. Sanchis-Gual, H. Okada da Silva. “Canuda: a public numerical relativity library to probe fundamental physics,” Zenodo (2023) doi: 10.5281/zenodo.3565474
ampef | Scope: restricted | REAL |
Description: amplitude of external forcing
| ||
Range | Default: 1.0 | |
*:* | Any value possible
| |
eps_r | Scope: restricted | REAL |
Description: of value if rr approaches zero in densities computation
| ||
Range | Default: 1.0d-06 | |
0:* | any small positive value possible
| |
evolution_method | Scope: restricted | KEYWORD |
Description: scalar variables evolution method
| ||
Range | Default: none | |
none | scalar variables are not evolved
| |
forcing_switch | Scope: restricted | BOOLEAN |
Description: add external forcing to the rhs of Klein-Gordon
| ||
Default: no | ||
initial_scalar | Scope: restricted | KEYWORD |
Description: initial data for scalar variables
| ||
Range | Default: none | |
none | scalar variables are not initialized
| |
kphi1_0 | Scope: restricted | REAL |
Description: asymptotic value for Kphi1
| ||
Range | Default: (none) | |
*:* | ||
kphi2_0 | Scope: restricted | REAL |
Description: asymptotic value for Kphi2
| ||
Range | Default: (none) | |
*:* | ||
lef | Scope: restricted | INT |
Description:
| ||
Range | Default: (none) | |
0:2 | angular multipoles implemented are l = m = 0,1,2
| |
mef | Scope: restricted | INT |
Description:
| ||
Range | Default: (none) | |
0:2 | angular multipoles implemented are l = m = 0,1,2
| |
mu | Scope: restricted | REAL |
Description: mass of the scalar fields
| ||
Range | Default: (none) | |
0:* | any non-negative number
| |
n_kphi1 | Scope: restricted | INT |
Description: n power of outgoing boundary r fall off rate for Kphi1
| ||
Range | Default: 2 | |
0:4 | ??
| |
n_kphi2 | Scope: restricted | INT |
Description: n power of outgoing boundary r fall off rate for Kphi2
| ||
Range | Default: 2 | |
0:4 | ??
| |
n_phi1 | Scope: restricted | INT |
Description: n power of outgoing boundary r fall off rate for phi1
| ||
Range | Default: 1 | |
0:4 | ??
| |
n_phi2 | Scope: restricted | INT |
Description: n power of outgoing boundary r fall off rate for phi2
| ||
Range | Default: 1 | |
0:4 | ??
| |
omegaef | Scope: restricted | REAL |
Description: oscillation frequency of external forcing
| ||
Range | Default: 0.0 | |
0:* | Any positive value
| |
phi1_0 | Scope: restricted | REAL |
Description: asymptotic value for phi1
| ||
Range | Default: (none) | |
*:* | ||
phi2_0 | Scope: restricted | REAL |
Description: asymptotic value for phi2
| ||
Range | Default: (none) | |
*:* | ||
ref | Scope: restricted | REAL |
Description: peak position of external forcing
| ||
Range | Default: 10.0 | |
0:* | Any positive value
| |
v_lambda | Scope: restricted | REAL |
Description: interaction term in the potential
| ||
Range | Default: (none) | |
*:* | ||
widthef | Scope: restricted | REAL |
Description: width of external forcing
| ||
Range | Default: 10.0 | |
0:* | Any positive value
| |
Implements:
scalarbase
Inherits:
grid
Group Names | Variable Names | Details | |
phi | compact | 0 | |
phi1 | description | scalar fields | |
phi2 | dimensions | 3 | |
distribution | DEFAULT | ||
group type | GF | ||
tags | tensortypealias=”Scalar” tensorweight=0 | ||
timelevels | 3 | ||
variable type | REAL | ||
kphi | compact | 0 | |
Kphi1 | description | their conjugated momenta | |
Kphi2 | dimensions | 3 | |
distribution | DEFAULT | ||
group type | GF | ||
tags | tensortypealias=”Scalar” tensorweight=0 | ||
timelevels | 3 | ||
variable type | REAL | ||
fext | compact | 0 | |
Fext1 | description | scalar field external forcing function | |
Fext2 | dimensions | 3 | |
distribution | DEFAULT | ||
group type | GF | ||
tags | tensortypealias=”Scalar” tensorweight=0 | ||
timelevels | 3 | ||
variable type | REAL | ||
This section lists all the variables which are assigned storage by thorn Scalar/ScalarBase. Storage can either last for the duration of the run (Always means that if this thorn is activated storage will be assigned, Conditional means that if this thorn is activated storage will be assigned for the duration of the run if some condition is met), or can be turned on for the duration of a schedule function.
Always: | Conditional: |
phi[3] Kphi[3] | Fext[3] |
CCTK_WRAGH
scalarbase_symmetries
register symmetries of the grid functions
Language: | fortran | |
Options: | global | |
Type: | function | |
MoL_Step (conditional)
scalar_rhs_force
writes external force grid function
Before: | mol_calcrhs | |
Language: | fortran | |
Options: | local | |
Type: | function | |