Octopus
wigner_distribution_oct_m::wigner_distribution_t Type Reference

Class describing a Wigner distribution for sampling initial conditions in multi-trajectory Ehrenfest runs. More...

Detailed Description

Class describing a Wigner distribution for sampling initial conditions in multi-trajectory Ehrenfest runs.

Definition at line 124 of file wigner_distribution.F90.

Private Member Functions

procedure init => wigner_distribution_init
 Initialize the Wigner distribution. More...
 
procedure end => wigner_distribution_end
 Deallocate internal memory. More...
 
procedure get => wigner_distribution_get
 Get random numbers with given standard deviation and mean per mode. More...
 

Private Attributes

integer num_modes
 Number of modes. More...
 
real(real64), dimension(:, :), allocatable random_numbers
 Two sets of normal-distributed random numbers (1:num_modes, 1:2) More...
 

Member Function/Subroutine Documentation

◆ init()

procedure wigner_distribution_oct_m::wigner_distribution_t::init
private

Initialize the Wigner distribution.

This initializer invokes the random number generator and creates two sets of normal-distributed random numbers.

Parameters
[in,out]thisThe Wigner function object
[in]num_modesNumber of boson modes
[in]seedInitial seed for the random number generator

Definition at line 133 of file wigner_distribution.F90.

◆ end()

procedure wigner_distribution_oct_m::wigner_distribution_t::end
private

Deallocate internal memory.

Definition at line 134 of file wigner_distribution.F90.

◆ get()

procedure wigner_distribution_oct_m::wigner_distribution_t::get
private

Get random numbers with given standard deviation and mean per mode.

The variable set controls whether to get the displacements for the canonical position or momentum. Possible values are

  • WIGNER_Q (position)
  • WIGNER_P (momentum)
    Parameters
    [in]sigmastandard deviations per mode
    [in]mumean value per mode
    [in]setchoose the set of raw random numbers

Definition at line 135 of file wigner_distribution.F90.

Member Data Documentation

◆ num_modes

integer wigner_distribution_oct_m::wigner_distribution_t::num_modes
private

Number of modes.

Definition at line 128 of file wigner_distribution.F90.

◆ random_numbers

real(real64), dimension(:, :), allocatable wigner_distribution_oct_m::wigner_distribution_t::random_numbers
private

Two sets of normal-distributed random numbers (1:num_modes, 1:2)

Definition at line 129 of file wigner_distribution.F90.


The documentation for this type was generated from the following file: