diagnostics_final_routines

Diagnostic routines that are called at the end of the simulation, rather than during the run

Subroutines

init_par_filter par_spectrum do_write_final_fields do_write_kpar do_write_final_epar get_epar do_write_final_db do_write_final_moments do_write_final_antot do_write_gs

Subroutines

public subroutine init_par_filter()

Setup the FFTs for calculating the parallel spectrum

Arguments

None

private subroutine par_spectrum(an, an2)

Calculate the parallel spectrum

Arguments

Type	Intent	Optional	Attributes		Name
complex,	intent(in),		dimension(:,:,:)	::	an
complex,	intent(out),		dimension(:,:,:)	::	an2

public subroutine do_write_final_fields(write_text, file_id)

Write $\phi, A_\parallel, B_\parallel$ , overwriting existing values

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	write_text	Write to text file
integer,	intent(in)			::	file_id	NetCDF ID of the file to write to

public subroutine do_write_kpar(write_text)

Write the parallel spectrum of $\phi, A_\parallel, B_\parallel$ , overwriting existing values

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	write_text	Write to text file

public subroutine do_write_final_epar(write_text, file_id)

Calculate and write $E_\parallel$ , overwriting existing values

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	write_text	Write to text file
integer,	intent(in)			::	file_id	NetCDF ID of the file to write to

private subroutine get_epar(phi, apar, phinew, aparnew, epar)

Calculate $E_\parallel$

Arguments

Type	Intent	Attributes		Name
complex,	intent(in),	dimension(-ntgrid:,:,:)	::	phi
complex,	intent(in),	dimension(-ntgrid:,:,:)	::	apar
complex,	intent(in),	dimension(-ntgrid:,:,:)	::	phinew
complex,	intent(in),	dimension(-ntgrid:,:,:)	::	aparnew
complex,	intent(out),	dimension(-ntgrid:,:,:)	::	epar

public subroutine do_write_final_db(write_text)

Calculate and write $\delta B$ , overwriting existing values

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	write_text	Write to text file

public subroutine do_write_final_moments(phi0_in, use_normalisation, write_text, file_id)

Calculate and write the various low-order moments, overwriting existing values

Arguments

Type	Intent	Attributes		Name
complex,	intent(in),	dimension (:, :)	::	phi0_in	Pre-calculated phase
logical,	intent(in)		::	use_normalisation	Use phi0_in as normalisation
logical,	intent(in)		::	write_text	Write to text file
integer,	intent(in)		::	file_id	NetCDF ID of the file to write to

public subroutine do_write_final_antot(write_text, file_id)

Write the right-hand sides of the field equations, overwriting existing values

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	write_text	Write to text file
integer,	intent(in)			::	file_id	NetCDF ID of the file to write to

public subroutine do_write_gs(write_text)

FIXME : Add documentation

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	write_text	Write to text file

diagnostics_final_routines Module

Contents

Subroutines

Contents

Subroutines

Subroutines

public subroutine init_par_filter()

Arguments

private subroutine par_spectrum(an, an2)

Arguments

public subroutine do_write_final_fields(write_text, file_id)

Arguments

public subroutine do_write_kpar(write_text)

Arguments

public subroutine do_write_final_epar(write_text, file_id)

Arguments

private subroutine get_epar(phi, apar, phinew, aparnew, epar)

Arguments

public subroutine do_write_final_db(write_text)

Arguments

public subroutine do_write_final_moments(phi0_in, use_normalisation, write_text, file_id)

Arguments

public subroutine do_write_final_antot(write_text, file_id)

Arguments

public subroutine do_write_gs(write_text)

Arguments