Octopus
batch_oct_m::batch_init Interface Reference

initialize a batch with existing memory More...

Detailed Description

initialize a batch with existing memory

Note
the provided arrays are assumed to be in unpacked shape.

Definition at line 267 of file batch.F90.

Private Member Functions

subroutine dbatch_init_with_memory_3 (this, dim, st_start, st_end, psi)
 initialize a batch with an rank-3 array of TYPE_FLOAT valued mesh functions psi. More...
 
subroutine zbatch_init_with_memory_3 (this, dim, st_start, st_end, psi)
 initialize a batch with an rank-3 array of TYPE_CMPLX valued mesh functions psi. More...
 
subroutine dbatch_init_with_memory_2 (this, dim, st_start, st_end, psi)
 initialize a batch with an rank-2 array of TYPE_FLOAT valued mesh functions psi. More...
 
subroutine zbatch_init_with_memory_2 (this, dim, st_start, st_end, psi)
 initialize a batch with an rank-2 array of TYPE_CMPLX valued mesh functions psi. More...
 
subroutine dbatch_init_with_memory_1 (this, psi)
 initialize a batch with an rank-1 array of TYPE_FLOAT valued mesh functions psi. More...
 
subroutine zbatch_init_with_memory_1 (this, psi)
 initialize a batch with an rank-1 array of TYPE_CMPLX valued mesh functions psi. More...
 

Member Function/Subroutine Documentation

◆ dbatch_init_with_memory_3()

subroutine batch_oct_m::batch_init::dbatch_init_with_memory_3 ( class(batch_t), intent(out)  this,
integer, intent(in)  dim,
integer, intent(in)  st_start,
integer, intent(in)  st_end,
real(real64), dimension(:, :, st_start:), intent(in), target, contiguous  psi 
)
private

initialize a batch with an rank-3 array of TYPE_FLOAT valued mesh functions psi.

The TYPE_FLOAT valued mesh functions psi are expected to be of dimensions (1:np_batch, 1:dim, st_start:st_end) where np_batch can be either np or np_part

Definition at line 1331 of file batch.F90.

◆ zbatch_init_with_memory_3()

subroutine batch_oct_m::batch_init::zbatch_init_with_memory_3 ( class(batch_t), intent(out)  this,
integer, intent(in)  dim,
integer, intent(in)  st_start,
integer, intent(in)  st_end,
complex(real64), dimension(:, :, st_start:), intent(in), target, contiguous  psi 
)
private

initialize a batch with an rank-3 array of TYPE_CMPLX valued mesh functions psi.

The TYPE_CMPLX valued mesh functions psi are expected to be of dimensions (1:np_batch, 1:dim, st_start:st_end) where np_batch can be either np or np_part

Definition at line 1636 of file batch.F90.

◆ dbatch_init_with_memory_2()

subroutine batch_oct_m::batch_init::dbatch_init_with_memory_2 ( class(batch_t), intent(out)  this,
integer, intent(in)  dim,
integer, intent(in)  st_start,
integer, intent(in)  st_end,
real(real64), dimension(:, :), intent(in), target, contiguous  psi 
)
private

initialize a batch with an rank-2 array of TYPE_FLOAT valued mesh functions psi.

The TYPE_FLOAT valued mesh functions psi are expected to be either of the following dimensions:

  • (1:np_batch, st_start:st_end)
  • (1:np_batch, 1:dim)

where np_batch can be either np or np_part.

Note
Either dim==1 or st_start==st_end has to be fulfilled.

Definition at line 1368 of file batch.F90.

◆ zbatch_init_with_memory_2()

subroutine batch_oct_m::batch_init::zbatch_init_with_memory_2 ( class(batch_t), intent(out)  this,
integer, intent(in)  dim,
integer, intent(in)  st_start,
integer, intent(in)  st_end,
complex(real64), dimension(:, :), intent(in), target, contiguous  psi 
)
private

initialize a batch with an rank-2 array of TYPE_CMPLX valued mesh functions psi.

The TYPE_CMPLX valued mesh functions psi are expected to be either of the following dimensions:

  • (1:np_batch, st_start:st_end)
  • (1:np_batch, 1:dim)

where np_batch can be either np or np_part.

Note
Either dim==1 or st_start==st_end has to be fulfilled.

Definition at line 1673 of file batch.F90.

◆ dbatch_init_with_memory_1()

subroutine batch_oct_m::batch_init::dbatch_init_with_memory_1 ( class(batch_t), intent(out)  this,
real(real64), dimension(:), intent(in), target, contiguous  psi 
)
private

initialize a batch with an rank-1 array of TYPE_FLOAT valued mesh functions psi.

The TYPE_FLOAT valued mesh functions psi are expected to be of dimensions (1:np_batch) where np_batch can be either np or np_part.

Note
The given mesh function is always copied into the first slot of the batch, i.e. idim=1 and s_start=st_end=1.

Definition at line 1397 of file batch.F90.

◆ zbatch_init_with_memory_1()

subroutine batch_oct_m::batch_init::zbatch_init_with_memory_1 ( class(batch_t), intent(out)  this,
complex(real64), dimension(:), intent(in), target, contiguous  psi 
)
private

initialize a batch with an rank-1 array of TYPE_CMPLX valued mesh functions psi.

The TYPE_CMPLX valued mesh functions psi are expected to be of dimensions (1:np_batch) where np_batch can be either np or np_part.

Note
The given mesh function is always copied into the first slot of the batch, i.e. idim=1 and s_start=st_end=1.

Definition at line 1702 of file batch.F90.


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