Octopus
quantity_oct_m::quantity_t Interface Reference

Systems (system_t) can expose quantities that can be used to calculate interactions with other systems. More...

Detailed Description

Systems (system_t) can expose quantities that can be used to calculate interactions with other systems.

Some quantities are dynamical variables of the system. Such quantities are usually updated by the propagation algorithm and cannot be calculated on-demand.

Definition at line 171 of file quantity.F90.

Public Attributes

character(len=:), allocatable, public label
 Label used to uniquely identify a quantity. More...
 
type(iteration_counter_t), public iteration
 Iteration counter storing the time at which the quantity was last updated. More...
 
logical, public always_available = .false.
 Can we use this quantity at any requested iteration? More...
 
logical, public updated_on_demand = .true.
 when is the quantity updated? More...
 
character(len=100), dimension(:), allocatable, public parents
 labels of the quantities required to compute this quantity More...
 

Private Member Functions

type(quantity_t) function quantity_constructor (label, always_available, updated_on_demand, iteration, parents)
 

Member Function/Subroutine Documentation

◆ quantity_constructor()

type(quantity_t) function quantity_oct_m::quantity_t::quantity_constructor ( character(len=*), intent(in)  label,
logical, intent(in), optional  always_available,
logical, intent(in), optional  updated_on_demand,
type(iteration_counter_t), intent(in), optional  iteration,
character(len=*), dimension(:), intent(in), optional  parents 
)
private

Definition at line 205 of file quantity.F90.

Member Data Documentation

◆ label

character(len=:), allocatable, public quantity_oct_m::quantity_t::label

Label used to uniquely identify a quantity.

Definition at line 173 of file quantity.F90.

◆ iteration

type(iteration_counter_t), public quantity_oct_m::quantity_t::iteration

Iteration counter storing the time at which the quantity was last updated.

Definition at line 177 of file quantity.F90.

◆ always_available

logical, public quantity_oct_m::quantity_t::always_available = .false.

Can we use this quantity at any requested iteration?

Definition at line 183 of file quantity.F90.

◆ updated_on_demand

logical, public quantity_oct_m::quantity_t::updated_on_demand = .true.

when is the quantity updated?

Definition at line 188 of file quantity.F90.

◆ parents

character(len=100), dimension(:), allocatable, public quantity_oct_m::quantity_t::parents

labels of the quantities required to compute this quantity

Definition at line 196 of file quantity.F90.


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