Octopus
minimizer_algorithm_oct_m Module Reference

This module implements the basic minimizer framework. More...

Detailed Description

This module implements the basic minimizer framework.

Data Types

type  minimizer_algorithm_t
 Abstract class implementing minimizers. More...
 

Functions/Subroutines

logical function minimizer_algorithm_do_operation (this, operation)
 Try to perform one operation of the algorithm. Return .true. if sucessful. More...
 
logical function, public minimizer_algorithm_finished (this)
 indicate whether a minimizer has reached the final time More...
 
subroutine minimizer_algorithm_init_iteration_counters (this)
 Initialize the minimizer and system clocks. More...
 
subroutine minimizer_algorithm_write_output_header (this)
 
logical function minimizer_continues_after_finished (this)
 

Function/Subroutine Documentation

◆ minimizer_algorithm_do_operation()

logical function minimizer_algorithm_oct_m::minimizer_algorithm_do_operation ( class(minimizer_algorithm_t), intent(inout)  this,
type(algorithmic_operation_t), intent(in)  operation 
)
private

Try to perform one operation of the algorithm. Return .true. if sucessful.

Definition at line 155 of file minimizer_algorithm.F90.

◆ minimizer_algorithm_finished()

logical function, public minimizer_algorithm_oct_m::minimizer_algorithm_finished ( class(minimizer_algorithm_t), intent(in)  this)

indicate whether a minimizer has reached the final time

Definition at line 167 of file minimizer_algorithm.F90.

◆ minimizer_algorithm_init_iteration_counters()

subroutine minimizer_algorithm_oct_m::minimizer_algorithm_init_iteration_counters ( class(minimizer_algorithm_t), intent(inout)  this)
private

Initialize the minimizer and system clocks.

Note that we initialize the system clock here because it requires knowledge of the time-step.

Definition at line 183 of file minimizer_algorithm.F90.

◆ minimizer_algorithm_write_output_header()

subroutine minimizer_algorithm_oct_m::minimizer_algorithm_write_output_header ( class(minimizer_algorithm_t), intent(in)  this)
private

Definition at line 192 of file minimizer_algorithm.F90.

◆ minimizer_continues_after_finished()

logical function minimizer_algorithm_oct_m::minimizer_continues_after_finished ( class(minimizer_algorithm_t), intent(in)  this)
private

Definition at line 206 of file minimizer_algorithm.F90.