Procedures

Adds a given element at a certain (row, column) position to the matrix datastructure. Elements that are zero are not added, sanity checks are done on the row and column indices.

Adds a new node to the linked list with a given column index and value.

Adds a given element to the node element, does type-checking of the polymorphic element given. Allowed types are complex, real, integer.

This routine builds the quadblock at one particular grid point in the Gaussian grid and for one particular Gaussian weight. For a 2x2 block at index $(i, j)$ in the top-left block we have $(2i, 2j)$ as index of the bottom-right corner of the 2x2 block. The other corners are then filled by subtracting one from an index.

interface to the different equilibrium submodules

Subroutine to append a new node to an already existing list of nodes. A new node is created, appended, and the tail is updated.

interface to the different solution methods implemented in submodules

Converts a given array to a banded datastructure.

Converts a given array to a Hermitian banded datastructure.

Utility function used by assert.fpp's assert macro.

Calculates the matrix-vector product of a general complex banded matrix and a complex vector. Uses the level 2 BLAS routine zgbmv.

Converts a banded datastructure to a full complex array.

Called when the eigenfunction subset selection is enabled, this checks if the global variables are properly set.

Deallocates all main variables, then calls the cleanup routines of all relevant subroutines to do the same thing.

Equality check between complex values

Checks if complex values are zero

interface to the different equilibrium submodules

checks a given complex value/array/matrix for infinity.

checks a given real value/array/matrix for infinity.

Checks a given complex value/array/matrix for NaN.

Checks a given real value/array/matrix for NaN.

Dedicated function to copy a matrix structure into a new matrix structure. The datastructure contains pointers, such that simply setting matrix1 = matrix2 may result in pointer target losses (and wrong results).

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Subroutine to start a CPU timer.

Subroutine to end a CPU timer.

Interpolates the atmospheric tables to the desired resolution. The temperature derivative is obtained numerically.

Subroutine to add the first node to the linked list. Allocates a new node and sets both the head and tail to this node.

Destructor, deallocates the node attributes.

Deallocates the matrix datastructure, nullifies all corresponding pointers and deallocates the various nodes in the rows.

Deletes a given node from the current row.

Deletes a given linked list row by recursively iterating over all nodes. Nullifies the pointers and deallocates the elements.

Destructor, deallocates variables.

Destructor, deallocates the datastructure.

Destructor, deallocates the datastructure.

Checks if the given matrix dimensions are valid. For now, we only accept square matrices. Returns .true. if rows equals cols, .false. otherwise.

interface to the different equilibrium submodules

Sets density derivative using the differential equation to ensure force balance, instead of relying on numerical differentiation.

Function to locate the index of a given character in a character array. Iterates over the elements and returns on the first hit, if no match was found zero is returned.

Function to locate the indices of an array of characters in another character array. Returns the indices of the first hit, it no match was found zero is returned.

interface to the different equilibrium submodules

Default profile for the solar gravitational field $$g(x) = g_\odot \left(\frac{R_\odot}{(R_\odot + x)}\right)^2$$

Converts a given 2D array to the linked-list matrix datastructure.

Retrieves the element at index (i, j) for an array of general type. Returns the element as a (casted) complex type.

Getter for kind of B-matrix in eigenvalue problem.

Returns the complex element associated with the linked-list node at position (row, column) in the matrix datastructure. Non-existing nodes correspond to zero values, so when a node at (row, column) is not foudn this function returns (complex) zero.

Initialises and calculates the eigenfunctions if requested.

Retrieves the element at position (row, col) of the original matrix. See the LAPACK documentation, element $a_{ij}$ of the original matrix is stored at position $(kd + 1 + i - j, j)$ if uplo = "U" and at position $(1 + i - j, j)$ if uplo = "L" in the banded storage.

Retrieves the element at position (row, col) of the original matrix. See the LAPACK documentation, element $a_{ij}$ of the original matrix is stored at position $(ku + 1 + i - j, j)$ (with $ku$ the number of superdiagonals).

Getter for dimension of eigenvalue problem.

Retrieves the normalised Hall factor as described by Porth et al. (2014).

interface to retrieve the index of an element in an array.

Returns the current label.

Calculates the LU factorisation of a complex banded matrix $A$. Uses the LAPACK routine zgbtrf.

Getter for length of workl array, returns 3 * ncv**2 + 5 * ncv

Getter for maximum number of iterations.

Subroutine to get the number of super- and sub-diagonals in the matrix.

Getter for number of Arnoldi basis vectors that should be calculated.

Getter for number of eigenvalues to calculate.

Returns a pointer to the node corresponding to the given column. Returns a nullified pointer if no node containing the given column index was found.

Returns the node element.

Calculates the numerical derivative of a given array. A sixth-order accurate central difference stencil is used to calculate the derivative. Near the edges a sixth-order accurate forward and backward difference stencil is used for the left and right boundary, respectively. It is assumed that the x values are all equally spaced. If this is not the case, a polynomial interpolation on a uniform grid can be done and that one can be differentiated instead. The stencils are as follows:

This relies on the behaviour of the basis functions. If a variable needs to be zero, then this is done by forcing the basis functions on that edge to zero. For both left and right edges the quadratic basis functions have a non-zero entry in their even rows/columns, whereas the cubic basis functions have a non-zero entry in their odd rows/columns. Concrete: - cubic, left: C2 is non-zero, zero out elements with spline(2) - cubic, right: C1 is non-zero, zero out elements with spline(1) - quad, left: Q4 is non-zero, zero out elements with spline(4) - quad, right: Q3 is non-zero, zero out elements with spline(3) See also ordening of a quadblock in mod_build_quadblock.

Parses the command line arguments and retrieves the parfile passed.

Getter for tolerance (relative accuracy) to indicate eigenvalue convergence.

Returns the total number of elements inside the banded matrix

Returns the total number of elements (nodes) across the various rows.

Returns the total number of elements inside the banded matrix.

Returns the total number of nonzero elements inside the banded matrix.

Getter for which eigenvalues to return.

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Converts a Hermitian banded datastructure to a full complex array.

Initialises all variables defined at module scope to NaN, including the wave numbers. This ensures that these have to be explicitly set.

Private subroutine, sets the pointer to the default method to be used when raising exceptions.

Numerically integrates the differential equation $$y'(x) = A(x)y(x) + B(x)$$ using a fifth-order Runge-Kutta method. The functions A(x) and B(x) are passed as arguments and should be conform to the given interface, that is, these should be real(dp) functions which take a single real(dp), intent(in) argument. The integration is performed on the interval [x0, x1] with a stepsize of dh = (x1 - x0) / (nbpoints - 1).

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Interpolates a given set of tables (x, y(x)) into a smooth curve. Assumes that x_table is an array with a monotone increase in values. Interpolation is done using n_interp points, in general a second order polynomial approximation is used except near sharp jumps.

interface to the different solution methods implemented in submodules

Checks if a Hermitian band matrix is compatible with another Hermitian band matrix. This implies that the following attributes should be equal: - number of rows/columns - number of sub/superdiagonals - storage of upper or lower triangular part - dimensions of the banded matrices themselves Returns .true. if all criteria are satisfied, .false. otherwise.

Checks if a banded matrix is compatibe with another banded matrix. This implies that the following attributes should be equal: - dimensions of the original matrices - number of superdiagonals and subdiagonals - dimensions of the banded matrices themselves Returns .true. if these three criteria are satisfied, .false. otherwise.

interface to check if an array is constant

interface to check equality between values/arrays

interface to check for inf values

interface to check for NaN values

interface to check for negative values

Checks if a given element is valid in order to add it to the matrix. Returns .true. if the element is of type real or complex, .false. otherwise.

Checks if a given index is valid for the current matrix datastructure. Returns .true. if the index (either row or column) is larger than 0 and smaller than the dimension of the matrix. Returns .false. otherwise.

Checks if a given position (row, col) is within the banded structure. For uplo = "U" the position is within the band if $$max(1, col - kd) \leq row \leq col,$$ for uplo = "L" the position is within the band if $$col \leq row \leq min(n, col + kd)$$ with $kd$ the number of sub/superdiagonals and $n$ the number of rows/columns.

Checks if a given position (row, col) is within the banded structure, i.e. $$max(1, col - ku) \leq row \leq min(m, col + kl)$$ with $ku$ the number of superdiagonals and $kl$ the number of subdiagonals.

interface to check if values/arrays are zero

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Function for fast table-lookup, returns the corresponding y-value in y_values based on a given based on a given $x0$. If the allow_outside flag is given as .true. then values on the edge of the table are returned when the lookup value is outside the array. Uses simple linear interpolation.

interface to the different equilibrium submodules

Converts a given matrix data structure with complex nodes to a 2D complex array.

Converts a matrix data structure into a complex banded matrix.

Converts a matrix data structure into a complex Hermitian banded matrix.

interface to the different equilibrium submodules

Check if we need a no-slip condition on the left-hand side (i.e. viscosity). Does not apply on-axis for cylindrical unless two coaxial wall are present.

Check if we need a no-slip condition on the right-hand side (i.e. viscosity).

Checks if we need regularity conditions on temperature, this is the case if we have perpendicular thermal conduction.

Constructor for a new ARPACK configuration based on the dimension of the eigenvalue problem, mode of the solver and type of the B-matrix. Initialises required variables and allocates work arrays to be used when calling the solvers.

Constructor for a new banded matrix with a given number of rows, columns, subdiagonals and superdiagonals. Allocates and initialises the datatype.

Constructor for a new Hermitian banded matrix with a given number of rows and diagonals. Allocates and initialises the datatype. initialise all to zero

Constructor for a new matrix matrix with a given number of rows. Allocates and initialises the matrix datatype.

Constructor for a new node, sets the column and element attributes. The element passed is polymorphic, but will be cast to complex in the node itself. No nodes are linked yet; the pointer to the next node is initialised to null().

Constructor for a new row, initialises the linked list datastructure and sets the current head and tail pointers to null().

Workflow that is executed by default when an exception is raised. The argument message is printed to the console and program execution is terminated.

Subroutine to paint a given string to the desired colour, returns a new string with ANSI escape sequences prepended and appended. If the 'colour' argument is not known, simply returns the string itself.

Parses the statistics that come out of ARPACK when the run is finished. Displays the number of OPX and BX operations and the number of re-orthogonalisation steps that were needed.

Parses the info parameter that comes out of ARPACK's znaupd method. If info = 0, everything behaved nicely and the reverse communication subroutines exited properly. If info is any other value something went wrong and we handle it accordingly.

Parses the info parameter that comes out of ARPACK's zneupd method. If info = 0, the eigenvalues extraction routines exited properly, if info is any other value something went wrong and we handle it accordingly.

interface to the different equilibrium submodules

Prints various console messages showing geometry, grid parameters, equilibrium parameters etc. Only for logging level "info" or above.

Prints the Legolas logo to the console. The logo is wrapped in 1 whitespace at the top and two at the bottom. Only for logging level 'warning' (1) and above

Prints an empty line to the console. Only if logging level is 'warning' or above.

interface to the different solution methods implemented in submodules

interface to the different solution methods implemented in submodules

interface to the different solution methods implemented in submodules

Raises an exception with a given message. By default, exceptions terminate program execution. Calls the initialisation routine if not already done.

Check if an array has constant values

Equality check between real values

Check if values are or contain negative numbers

Checks if real values are zero

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Calculates the Runge-Kutta coefficients and calculates the fourth and fifth order solutions for step i+1 based on the values at step i.

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Sets the type of B-matrix.

Sets the element $a_{ij}$ of the original array into the banded structure. The row and col arguments refer to the row and column indices of the element in the original array. This routine has no effect if the location falls outside of the banded structure.

Sets the element $a_{ij}$ of the original array into the banded structure. The row and col arguments refer to the row and column indices of the element in the original array. This routine has no effect if the location falls outside of the banded structure.

Calls the routine to set the equilibrium pointer, then calls the correct submodule. Performs some sanity checks (negative values, NaNs etc.) when the equilibrium is set, then calls additional physics modules if needed.

Selects the submodule based on the specified equilibrium in the parfile. Works on a case-select basis.

Sets the label of the current matrix.

Sets the maximum number of iterations that ARPACK is allowed to take, defaults to max(100, 10 * k) with k the number of eigenvalues.

Sets the mode for the solver.

Setter for ncv, the number of Arnoldi basis vectors to calculate. This should satisfy 1 <= ncv - nev and ncv <= evpdim, with recommended value ncv = 2 * nev (see arpack docs).

Setter for number of eigenvalues to calculate.

Subroutine meant to be publicly called, sets the routine to be used when raising exceptions. Calls the initialisation routine if not already done.

Setter for the residual vector, allocates and manually initialises the residual (= starting) vector using a uniform distribution on (-1, 1) for both the real and imaginary parts. Relies on the LAPACK routine zlarnv.

interface to check for small values

Sets the density, temperature, gravity and magnetic field attributes of the respective fields to a realistic solar atmosphere profile. This routine first interpolates the temperature and numberdensity table at n_interp resolution, then solves the following ODE for the density: $$\rho'(x) = -\frac{T'(x) + g(x)}{T(x)}\rho(x) - \frac{B_{02}(x)B'_{02}(x) + B_{03}(x)B'_{03}(x)}{T(x)}$$ using a fifth order Runge-Kutta method. If the optional argument save_to is provided then the density profiles are saved to that file, which can be loaded back in on subsequent runs through the optional argument load_from. The integration is done over the entire table, the curve is sampled on the Gaussian grid, meaning that grid variations can all use the same result.

Setter for the "which" argument of ARPACK routines.

Small value checks for a complex variable/array/matrix, with the real and imaginary parts checked separately. Values that are smaller than the specified tolerance tol are set to zero. If tol is not present, DP_LIMIT is used as tolerance.

Small value checks for a real variable/array/matrix. Values that are smaller than the specified tolerance tol are set to zero. If tol is not present, DP_LIMIT is used as tolerance.

Main subroutine to solve the eigenvalue problem. Depending on the solvelist passed in the parfile, different solvers are called.

Calculates the solution $X$ to a system of linear equations $AX = B$ where $A$ is a complex banded matrix and $B$ is a complex vector.

Calculates the solution $X$ to a system of linear equations $AX = B$ where $A$ is a complex banded matrix and $B$ is a complex vector. Uses the LU factorisation of $A$ and pivoting information from zgbtrf.

Default profile for the derivative of the resistivity $\eta$ with respect to position. Returns zero unless a dropoff profile was chosen.

Default profile for the derivative of the resistivity $\eta$ with respect to the temperature $T$. Returns one of the following: - zero (if resistivity is disabled or for fixed resistivity) - derivative of Spitzer resistivity with respect to T Values are normalised on return.

Default profile for the resistivity $\eta$. Returns one of the following: - The Spitzer resistivity based on the equilibrium temperature profile - a fixed resistivity value - zero (if resistivity is disabled) Values are normalised on return.

interface to the different equilibrium submodules

interface to the different equilibrium submodules

interface to the different equilibrium submodules

Subroutine to start a wall clock timer.

Subroutine to end a wall clock timer.

Checks whether the given uplo parameter is valid.

interface to the different equilibrium submodules

Zeroes out the row and column corresponding to the given indices. Afterwards diagonal_factor is introduced in that row/column on the main diagonal.