scalar_schw_eff_implementation

The implementation of the interfaces provided in scalar_schw_eff.

Uses

- Ancestors:
- scalar_schw_eff
Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Interfaces

initialize_source set_time_window_coeffs set_particle_pos evaluate_source_all get_phi get_dphidt get_dphidr

Module Procedures

scal_schw_eff_init scal_schw_eff_set_particle_pos scal_schw_eff_set_time_window scal_schw_eff_evaluate_source scal_schw_eff_get_singular scal_schw_eff_get_dsingular_dt scal_schw_eff_get_dsingular_dr

Interfaces

interface

subroutine initialize_source(nmodes, l, m, mass) bind(c, name="0")

Interface to the C++ routine init_source for initializing the C++ effective source class.

Arguments

Type	Attributes		Name
integer(kind=c_int)		::	nmodes	The number of modes.
integer(kind=c_int),	dimension(nmodes)	::	l	A 1d array that contains the $\ell$ -values.
integer(kind=c_int),	dimension(nmodes)	::	m	A 1d array that contains the $m$ -values.
real(kind=c_double)		::	mass	The mass of the black hole.

interface

subroutine set_time_window_coeffs(tfac, dtfac_dt, d2tfac_dt2, do_smooth_after_lmax, nmodes) bind(c, name="0")

Interface to the C++ routine set_time_window that sets the time window information in the C++ effective source class.

Arguments

Type		Name
real(kind=c_double)	::	tfac	The time window factor.
real(kind=c_double)	::	dtfac_dt	The first time derivative of the time window factor.
real(kind=c_double)	::	d2tfac_dt2	The second time derivative of the time window factor.
integer(kind=c_int)	::	do_smooth_after_lmax	Only set the time window for $\ell>$ do_smooth_after_lmax.
integer(kind=c_int)	::	nmodes	The number of modes.

interface

subroutine set_particle_pos(r, phi, ur, En, Lz, ar, aphi, dardt, daphidt, d2ardt2, d2aphidt2, nmodes) bind(c, name="0")

Interface to the C++ routine set_particle that sets the particle information in the C++ effective source class.

Arguments

Type		Name
real(kind=c_double)	::	r	The radial coordinate of the particle (in Schwarzschild coordinates), $r$ .
real(kind=c_double)	::	phi	The azimuthal angle of the particle, $\phi$ .
real(kind=c_double)	::	ur	The radial component of the 4-velocity, $u^r$ .
real(kind=c_double)	::	En	The energy per unit mass of the particle, $E$ .
real(kind=c_double)	::	Lz	The angular momentum per unit mass of the particle $L_z$ .
real(kind=c_double)	::	ar	The radial component of the 4-acceleration, $a^r$ .
real(kind=c_double)	::	aphi	The $\phi$ -component of the 4-acceleration, $a^{\phi}$ .
real(kind=c_double)	::	dardt	The derivative of $a^r$ with respect to Schwarzschild coordinate time.
real(kind=c_double)	::	daphidt	The derivative of $a^{\phi}$ with respect to Schwarzschild coordinate time.
real(kind=c_double)	::	d2ardt2	The second derivative of $a^r$ with respect to Schwarzschild coordinate time.
real(kind=c_double)	::	d2aphidt2	The second derivative of $a^{\phi}$ with respect to Schwarzschild coordinate time.
integer(kind=c_int)	::	nmodes	The number of modes.

interface

subroutine evaluate_source_all(mode, n, r, win, dwin, d2win, sre, sim) bind(c, name="0")

Interface to the C++ routine eval_source_all that evaluates the effective source on the locations provided in a 1d input array.

Arguments

Type		Name
integer(kind=c_int)	::	mode	The mode.
integer(kind=c_int)	::	n	The number of elements in the input radial coordinate array, $r$ .
real(kind=c_double)	::	r(*)	The radial coordinates in Schwarzschild coordinates, $r_i$ .
real(kind=c_double)	::	win(*)	The window function, $W_i$ .
real(kind=c_double)	::	dwin(*)	The radial derivative of the window function, $\left .\frac{dW}{dr}\right \|_i$ .
real(kind=c_double)	::	d2win(*)	The second radial derivative of the window function, $\left .\frac{d^2W}{dr^2}\right \|_i$ .
real(kind=c_double)	::	sre(*)	The real part of the effective source, $\mathcal{R}(S_{\mathrm{eff}})$ .
real(kind=c_double)	::	sim(*)	The imaginary part of the effective source, $\mathcal{I}(S_{\mathrm{eff}})$ .

interface

subroutine get_phi(mode, r, phire, phiim) bind(c, name="0")

Interface to the C++ routine Phi that evaluates the singuler field at a given radial coordinate in Schwarzschild coordinates.

Arguments

Type		Name
integer(kind=c_int)	::	mode	The mode.
real(kind=c_double)	::	r	The radial coordinate, $r$ , in Schwarzschild coordinates.
real(kind=c_double)	::	phire	On output the real part of the singular field $\cal{R}(\Phi(r))$ .
real(kind=c_double)	::	phiim	On output the imaginary part of the singular field $\cal{I}(\Phi(r))$ .

interface

subroutine get_dphidt(mode, r, dphidtre, dphidtim) bind(c, name="0")

Interface to the C++ routine dPhi_dt that evaluates the time derivative of the singuler field at a given radial coordinate in Schwarzschild coordinates.

Arguments

Type		Name
integer(kind=c_int)	::	mode	The mode.
real(kind=c_double)	::	r	The radial coordinate, $r$ , in Schwarzschild coordinates.
real(kind=c_double)	::	dphidtre	On output the real part of the time derivative of the singular field $\cal{R}\left (\left .\frac{d\Phi}{dt}\right \|_r\right )$ .
real(kind=c_double)	::	dphidtim	On output the imaginary part of the time derivative of the singular field $\cal{R}\left (\left .\frac{d\Phi}{dt}\right \|_r\right )$ .

interface

subroutine get_dphidr(mode, r, dphidrre, dphidrim) bind(c, name="0")

Interface to the C++ routine dPhi_dt that evaluates the radial derivative of the singuler field at a given radial coordinate in Schwarzschild coordinates.

Arguments

Type		Name
integer(kind=c_int)	::	mode	The mode.
real(kind=c_double)	::	r	The radial coordinate, $r$ , in Schwarzschild coordinates.
real(kind=c_double)	::	dphidrre	On output the real part of the radial derivative of the singular field $\cal{R}\left (\left .\frac{d\Phi}{dr}\right \|_r\right )$ .
real(kind=c_double)	::	dphidrim	On output the imaginary part of the radial derivative of the singular field $\cal{R}\left (\left .\frac{d\Phi}{dr}\right \|_r\right )$ .

Module Procedures

module procedure scal_schw_eff_init module subroutine scal_schw_eff_init(this, nmodes, nvars, l, m, mass)

Arguments

Type	Intent	Attributes		Name
class(scal_schw_eff),	intent(inout)		::	this	On return, the constructed object.
integer(kind=ip),	intent(in)		::	nmodes	The number of modes.
integer(kind=ip),	intent(in)		::	nvars	The number of variables.
integer(kind=c_int),	intent(in),	dimension(nmodes)	::	l	A 1d array of size nmodes containing the $\ell$ -values of the modes.
integer(kind=c_int),	intent(in),	dimension(nmodes)	::	m	A 1d array of size nmodes containing the m-values of the modes.
real(kind=wp),	intent(in)		::	mass	The mass of the black hole.

module procedure scal_schw_eff_set_particle_pos module subroutine scal_schw_eff_set_particle_pos(this, r, phi, ur, En, Lz, ar, aphi, dardt, daphidt, d2ardt2, d2aphidt2)

Arguments

Type	Intent		Name
class(scal_schw_eff),	intent(inout)	::	this	The routine is called on this object.
real(kind=wp),	intent(in)	::	r	The radial coordinate of the particle (in Schwarzschild coordinates), $r$ .
real(kind=wp),	intent(in)	::	phi	The azimuthal angle of the particle, $\phi$ .
real(kind=wp),	intent(in)	::	ur	The radial component of the 4-velocity, $u^r$ .
real(kind=wp),	intent(in)	::	En	The energy per unit mass of the particle, $E$ .
real(kind=wp),	intent(in)	::	Lz	The angular momentum per unit mass of the particle $L_z$ .
real(kind=wp),	intent(in)	::	ar	The radial component of the 4-acceleration, $a^r$ .
real(kind=wp),	intent(in)	::	aphi	The $\phi$ -component of the 4-acceleration, $a^{\phi}$ .
real(kind=wp),	intent(in)	::	dardt	The derivative of $a^r$ with respect to Schwarzschild coordinate time.
real(kind=wp),	intent(in)	::	daphidt	The derivative of $a^{\phi}$ with respect to Schwarzschild coordinate time.
real(kind=wp),	intent(in)	::	d2ardt2	The second derivative of $a^r$ with respect to Schwarzschild coordinate time.
real(kind=wp),	intent(in)	::	d2aphidt2	The second derivative of $a^{\phi}$ with respect to Schwarzschild coordinate time.

module procedure scal_schw_eff_set_time_window module subroutine scal_schw_eff_set_time_window(this, tfac, dtfac_dt, d2tfac_dt2, do_smooth_after_lmax)

Arguments

Type	Intent		Name
class(scal_schw_eff),	intent(inout)	::	this	The routine is called on this object.
real(kind=wp),	intent(in)	::	tfac	The current value for the time window.
real(kind=wp),	intent(in)	::	dtfac_dt	The current value for the time derivative of the time window.
real(kind=wp),	intent(in)	::	d2tfac_dt2	The current value for the second time derivative of the time window.
integer(kind=ip),	intent(in)	::	do_smooth_after_lmax	If $l<$ do_smooth_after_lmax use tfac=1, dtfac_dt=0, d2tfac_dt2=0. This allows for smooth turn on of the effective source for the modes with $l>$ do_smooth_after_lmax, while the rest gets turned on instantaneously (e.g. when external initial data is available).

module procedure scal_schw_eff_evaluate_source module subroutine scal_schw_eff_evaluate_source(this, r, wt)

Arguments

Type	Intent		Name
class(scal_schw_eff),	intent(inout)	::	this	The routine is called on this object.
type(rgf),	intent(in)	::	r	A real values grid function that contain the radial coordinate (in Schwarzschild coordinates).
type(wtube),	intent(in)	::	wt	A world-tube object that ensures that the effective source is only non-zero inside the world-tube.

module procedure scal_schw_eff_get_singular module subroutine scal_schw_eff_get_singular(this, r, mode, psi)

Arguments

Type	Intent	Attributes		Name
class(scal_schw_eff),	intent(inout)		::	this	The routine is called on this object.
real(kind=wp),	intent(in)		::	r	The radial coordinate (Schwarzschild coordinates).
integer(kind=ip),	intent(in)		::	mode	The mode.
complex(kind=wp),	intent(out),	dimension(:)	::	psi	A 1d-array of size nvars of complex values that on return contains the singular field for all variables.

module procedure scal_schw_eff_get_dsingular_dt module subroutine scal_schw_eff_get_dsingular_dt(this, r, mode, dpsidt)

Arguments

Type	Intent	Attributes		Name
class(scal_schw_eff),	intent(inout)		::	this	The routine is called on this object.
real(kind=wp),	intent(in)		::	r	The radial coordinate (Schwarzschild coordinates).
integer(kind=ip),	intent(in)		::	mode	The mode.
complex(kind=wp),	intent(out),	dimension(:)	::	dpsidt	A 1d-array of size nvars of complex values that on return contains the time derivative of the singular field for all variables.

module procedure scal_schw_eff_get_dsingular_dr module subroutine scal_schw_eff_get_dsingular_dr(this, r, mode, dpsidr)

Arguments

Type	Intent	Attributes		Name
class(scal_schw_eff),	intent(inout)		::	this	The routine is called on this object.
real(kind=wp),	intent(in)		::	r	The radial coordinate (Schwarzschild coordinates).
integer(kind=ip),	intent(in)		::	mode	The mode.
complex(kind=wp),	intent(out),	dimension(:)	::	dpsidr	A 1d-array of size nvars of complex values that on return contains the radial derivative of the singular field for all variables.

scalar_schw_eff_implementation Submodule

Contents

Interfaces

Module Procedures

Uses

Ancestors:

Contents

Interfaces

Module Procedures

Interfaces

interface

subroutine initialize_source(nmodes, l, m, mass) bind(c, name="0")

Arguments

interface

subroutine set_time_window_coeffs(tfac, dtfac_dt, d2tfac_dt2, do_smooth_after_lmax, nmodes) bind(c, name="0")

Arguments

interface

subroutine set_particle_pos(r, phi, ur, En, Lz, ar, aphi, dardt, daphidt, d2ardt2, d2aphidt2, nmodes) bind(c, name="0")

Arguments

interface

subroutine evaluate_source_all(mode, n, r, win, dwin, d2win, sre, sim) bind(c, name="0")

Arguments

interface

subroutine get_phi(mode, r, phire, phiim) bind(c, name="0")

Arguments

interface

subroutine get_dphidt(mode, r, dphidtre, dphidtim) bind(c, name="0")

Arguments

interface

subroutine get_dphidr(mode, r, dphidrre, dphidrim) bind(c, name="0")

Arguments

Module Procedures

module procedure scal_schw_eff_init module subroutine scal_schw_eff_init(this, nmodes, nvars, l, m, mass) Interface →

Arguments

module procedure scal_schw_eff_set_particle_pos module subroutine scal_schw_eff_set_particle_pos(this, r, phi, ur, En, Lz, ar, aphi, dardt, daphidt, d2ardt2, d2aphidt2) Interface →

Arguments

module procedure scal_schw_eff_set_time_window module subroutine scal_schw_eff_set_time_window(this, tfac, dtfac_dt, d2tfac_dt2, do_smooth_after_lmax) Interface →

Arguments

module procedure scal_schw_eff_evaluate_source module subroutine scal_schw_eff_evaluate_source(this, r, wt) Interface →

Arguments

module procedure scal_schw_eff_get_singular module subroutine scal_schw_eff_get_singular(this, r, mode, psi) Interface →

Arguments

module procedure scal_schw_eff_get_dsingular_dt module subroutine scal_schw_eff_get_dsingular_dt(this, r, mode, dpsidt) Interface →

Arguments

module procedure scal_schw_eff_get_dsingular_dr module subroutine scal_schw_eff_get_dsingular_dr(this, r, mode, dpsidr) Interface →

Arguments

module procedure scal_schw_eff_init module subroutine scal_schw_eff_init(this, nmodes, nvars, l, m, mass)

module procedure scal_schw_eff_set_particle_pos module subroutine scal_schw_eff_set_particle_pos(this, r, phi, ur, En, Lz, ar, aphi, dardt, daphidt, d2ardt2, d2aphidt2)

module procedure scal_schw_eff_set_time_window module subroutine scal_schw_eff_set_time_window(this, tfac, dtfac_dt, d2tfac_dt2, do_smooth_after_lmax)

module procedure scal_schw_eff_evaluate_source module subroutine scal_schw_eff_evaluate_source(this, r, wt)

module procedure scal_schw_eff_get_singular module subroutine scal_schw_eff_get_singular(this, r, mode, psi)

module procedure scal_schw_eff_get_dsingular_dt module subroutine scal_schw_eff_get_dsingular_dt(this, r, mode, dpsidt)

module procedure scal_schw_eff_get_dsingular_dr module subroutine scal_schw_eff_get_dsingular_dr(this, r, mode, dpsidr)