Octopus
utils_oct_m Module Reference

This module is intended to contain simple general-purpose utility functions and procedures. More...

Detailed Description

This module is intended to contain simple general-purpose utility functions and procedures.

Data Types

interface  lead_dim
 
interface  leading_dimension_is_known
 

Functions/Subroutines

subroutine, public get_divisors (nn, n_divisors, divisors)
 
character pure function, public index2axis (idir)
 
pure character(len=2) function, public index2axisbz (idir)
 
subroutine, public output_tensor (tensor, ndim, unit, write_average, iunit, namespace)
 
subroutine, public output_dipole (dipole, ndim, iunit, namespace)
 
subroutine, public print_header ()
 This subroutine prints the logo followed by information about the compilation and the system. It also prints the start time of the execution. More...
 
character(len=256) function, public get_config_opts ()
 Character string containing compile-time options. More...
 
character(len=256) function, public get_optional_libraries ()
 Character string containing optional external libraries. More...
 
logical function dleading_dimension_is_known (array)
 
logical function zleading_dimension_is_known (array)
 
logical function ileading_dimension_is_known (array)
 
logical function lleading_dimension_is_known (array)
 
logical function sleading_dimension_is_known (array)
 
logical function cleading_dimension_is_known (array)
 
logical function dleading_dimension_is_known2 (array)
 
logical function zleading_dimension_is_known2 (array)
 
logical function ileading_dimension_is_known2 (array)
 
logical function lleading_dimension_is_known2 (array)
 
logical function sleading_dimension_is_known2 (array)
 
logical function cleading_dimension_is_known2 (array)
 
integer function dlead_dim (array)
 
integer function zlead_dim (array)
 
integer function dlead_dim2 (array)
 
integer function zlead_dim2 (array)
 
integer function slead_dim (array)
 
integer function clead_dim (array)
 
integer function slead_dim2 (array)
 
integer function clead_dim2 (array)
 
subroutine, public make_array_larger (array, new_size)
 
subroutine write_vectorization_level ()
 Prints the level of vectorization used for the vectorized finite differences. More...
 

Function/Subroutine Documentation

◆ get_divisors()

subroutine, public utils_oct_m::get_divisors ( integer, intent(in)  nn,
integer, intent(inout)  n_divisors,
integer, dimension(:), intent(out)  divisors 
)

Definition at line 156 of file utils.F90.

◆ index2axis()

character pure function, public utils_oct_m::index2axis ( integer, intent(in)  idir)

Definition at line 190 of file utils.F90.

◆ index2axisbz()

pure character(len=2) function, public utils_oct_m::index2axisbz ( integer, intent(in)  idir)

Definition at line 209 of file utils.F90.

◆ output_tensor()

subroutine, public utils_oct_m::output_tensor ( real(real64), dimension(:,:), intent(in)  tensor,
integer, intent(in)  ndim,
type(unit_t), intent(in)  unit,
logical, intent(in), optional  write_average,
integer, intent(in), optional  iunit,
type(namespace_t), intent(in), optional  namespace 
)

Definition at line 230 of file utils.F90.

◆ output_dipole()

subroutine, public utils_oct_m::output_dipole ( real(real64), dimension(:), intent(in), contiguous  dipole,
integer, intent(in)  ndim,
integer, intent(in), optional  iunit,
type(namespace_t), intent(in), optional  namespace 
)

Definition at line 266 of file utils.F90.

◆ print_header()

subroutine, public utils_oct_m::print_header

This subroutine prints the logo followed by information about the compilation and the system. It also prints the start time of the execution.

Definition at line 289 of file utils.F90.

◆ get_config_opts()

character(len=256) function, public utils_oct_m::get_config_opts

Character string containing compile-time options.

Specified in include/config.h.in

Definition at line 352 of file utils.F90.

◆ get_optional_libraries()

character(len=256) function, public utils_oct_m::get_optional_libraries

Character string containing optional external libraries.

Specified in include/config.h.in

Definition at line 361 of file utils.F90.

◆ dleading_dimension_is_known()

logical function utils_oct_m::dleading_dimension_is_known ( real(real64), dimension(:, :), intent(in), target  array)
private

Definition at line 370 of file utils.F90.

◆ zleading_dimension_is_known()

logical function utils_oct_m::zleading_dimension_is_known ( complex(real64), dimension(:, :), intent(in), target  array)
private

Definition at line 388 of file utils.F90.

◆ ileading_dimension_is_known()

logical function utils_oct_m::ileading_dimension_is_known ( integer, dimension(:, :), intent(in), target  array)
private

Definition at line 405 of file utils.F90.

◆ lleading_dimension_is_known()

logical function utils_oct_m::lleading_dimension_is_known ( integer(int64), dimension(:, :), intent(in), target  array)
private

Definition at line 422 of file utils.F90.

◆ sleading_dimension_is_known()

logical function utils_oct_m::sleading_dimension_is_known ( real(real32), dimension(:, :), intent(in), target  array)
private

Definition at line 441 of file utils.F90.

◆ cleading_dimension_is_known()

logical function utils_oct_m::cleading_dimension_is_known ( complex(real32), dimension(:, :), intent(in), target  array)
private

Definition at line 459 of file utils.F90.

◆ dleading_dimension_is_known2()

logical function utils_oct_m::dleading_dimension_is_known2 ( real(real64), dimension(:, :, :), intent(in), target  array)
private

Definition at line 477 of file utils.F90.

◆ zleading_dimension_is_known2()

logical function utils_oct_m::zleading_dimension_is_known2 ( complex(real64), dimension(:, :, :), intent(in), target  array)
private

Definition at line 495 of file utils.F90.

◆ ileading_dimension_is_known2()

logical function utils_oct_m::ileading_dimension_is_known2 ( integer, dimension(:, :, :), intent(in), target  array)
private

Definition at line 512 of file utils.F90.

◆ lleading_dimension_is_known2()

logical function utils_oct_m::lleading_dimension_is_known2 ( integer(int64), dimension(:, :, :), intent(in), target  array)
private

Definition at line 528 of file utils.F90.

◆ sleading_dimension_is_known2()

logical function utils_oct_m::sleading_dimension_is_known2 ( real(real32), dimension(:, :, :), intent(in), target  array)
private

Definition at line 545 of file utils.F90.

◆ cleading_dimension_is_known2()

logical function utils_oct_m::cleading_dimension_is_known2 ( complex(real32), dimension(:, :, :), intent(in), target  array)
private

Definition at line 562 of file utils.F90.

◆ dlead_dim()

integer function utils_oct_m::dlead_dim ( real(real64), dimension(:, :), intent(in)  array)
private

Definition at line 579 of file utils.F90.

◆ zlead_dim()

integer function utils_oct_m::zlead_dim ( complex(real64), dimension(:, :), intent(in)  array)
private

Definition at line 589 of file utils.F90.

◆ dlead_dim2()

integer function utils_oct_m::dlead_dim2 ( real(real64), dimension(:, :, :), intent(in)  array)
private

Definition at line 599 of file utils.F90.

◆ zlead_dim2()

integer function utils_oct_m::zlead_dim2 ( complex(real64), dimension(:, :, :), intent(in)  array)
private

Definition at line 609 of file utils.F90.

◆ slead_dim()

integer function utils_oct_m::slead_dim ( real(real32), dimension(:, :), intent(in)  array)
private

Definition at line 619 of file utils.F90.

◆ clead_dim()

integer function utils_oct_m::clead_dim ( complex(real32), dimension(:, :), intent(in)  array)
private

Definition at line 629 of file utils.F90.

◆ slead_dim2()

integer function utils_oct_m::slead_dim2 ( real(real32), dimension(:, :, :), intent(in)  array)
private

Definition at line 639 of file utils.F90.

◆ clead_dim2()

integer function utils_oct_m::clead_dim2 ( complex(real32), dimension(:, :, :), intent(in)  array)
private

Definition at line 649 of file utils.F90.

◆ make_array_larger()

subroutine, public utils_oct_m::make_array_larger ( integer(int64), dimension(:), intent(inout), allocatable  array,
integer, intent(in)  new_size 
)

Definition at line 657 of file utils.F90.

◆ write_vectorization_level()

subroutine utils_oct_m::write_vectorization_level
private

Prints the level of vectorization used for the vectorized finite differences.

Definition at line 677 of file utils.F90.