Public Member Functions

procedure, public initialize => Origen_CaseWrapper__initialize
 Constructor for the ORIGEN API object. More...
 
procedure, public destroy => Origen_CaseWrapper__destroy
 destructor More...
 
procedure, public set_times => Origen_CaseWrapper__set_times
 Set the time steps. More...
 
procedure, public set_fluxes => Origen_CaseWrapper__set_fluxes
 Set fluxes (and say that input is done by flux). More...
 
procedure, public set_powers => Origen_CaseWrapper__set_powers
 Set powers (and say that input is done by power). More...
 
procedure, public run => Origen_CaseWrapper__run
 Run the calculation - this methods does all that needs to be done. More...
 
procedure, public set_initial_concentrations => Origen_CaseWrapper__set_initial_concentrations
 Set the initial concentrations for the problem (ORIGEN input style). More...
 
procedure, public set_initial_concentrations_by_vector => Origen_CaseWrapper__set_initial_concentrations_by_vector
 Set the initial concentrations for the problem (full concentration vector). More...
 
procedure, public set_initial_concentrations_from_concs => Origen_CaseWrapper__set_initial_concentrations_from_concs
 Set the initial concentrations from concs. More...
 
procedure, public set_initial_concentrations_from_file => Origen_CaseWrapper__set_initial_concentrations_from_file
 set initial concentrations from a file More...
 
procedure, public set_feed_rates => Origen_CaseWrapper__set_feed_rates
 Set the feed rates for the problem (ORIGEN input style). More...
 
procedure, public set_feed_rates_by_vector => Origen_CaseWrapper__set_feed_rates_by_vector
 Set the feed rates for the problem (full concentration vector). More...
 
procedure, public load_new_concentrations => Origen_CaseWrapper__load_new_concentrations
 Load new concentrations from the input file arrays. More...
 
procedure, public save_states => Origen_CaseWrapper__save_states
 Save states of the problem. More...
 
procedure, public create_state_header => Origen_CaseWrapper__create_state_header
 
procedure, public create_state => Origen_CaseWrapper__create_state
 
procedure, public get_concentrations => Origen_CaseWrapper__get_concentrations
 Get the concentrations matrix (after the calculation). More...
 
procedure, public get_concentrations_at_time => Origen_CaseWrapper__get_concentrations_at_time
 
procedure, public nsteps => Origen_CaseWrapper__nsteps
 Data retriever methods. More...
 
procedure, public get_input_by_flux => Origen_CaseWrapper__get_input_by_flux
 
procedure, public get_adjoint => Origen_CaseWrapper__get_adjoint
 
procedure, public get_fixed_fission_energy => Origen_CaseWrapper__get_fixed_fission_energy
 
procedure, public get_volume => Origen_CaseWrapper__get_volume
 
procedure, public get_decay_only => Origen_CaseWrapper__get_decay_only
 
procedure, public get_times => Origen_CaseWrapper__get_times
 Data retrievers for arrays. More...
 
procedure, public get_fluxes => Origen_CaseWrapper__get_fluxes
 
procedure, public get_powers => Origen_CaseWrapper__get_powers
 
procedure, public get_burnups => Origen_CaseWrapper__get_burnups
 
procedure, public get_concentrations0 => Origen_CaseWrapper__get_concentrations0
 
procedure, public get_reprocessing_rate => Origen_CaseWrapper__get_reprocessing_rate
 
procedure, public get_feed_rate => Origen_CaseWrapper__get_feed_rate
 
procedure, public total_nuclides => Origen_CaseWrapper__total_nuclides
 
procedure, public times_at => Origen_CaseWrapper__get_times_at
 Single elements data retrievers (at element i or i,j) More...
 
procedure, public fluxes_at => Origen_CaseWrapper__get_fluxes_at
 
procedure, public powers_at => Origen_CaseWrapper__get_powers_at
 
procedure, public burnups_at => Origen_CaseWrapper__get_burnups_at
 
procedure, public fluence_at => Origen_CaseWrapper__get_fluence_at
 
procedure, public concentrations0_at => Origen_CaseWrapper__get_concentrations0_at
 
procedure, public concentrations_at => Origen_CaseWrapper__get_concentrations_at
 
procedure, public reprocessing_rate_at => Origen_CaseWrapper__get_reprocessing_rate_at
 
procedure, public feed_rate_at => Origen_CaseWrapper__get_feed_rate_at
 
procedure, public set_fixed_fission_energy => Origen_CaseWrapper__set_fixed_fission_energy
 Data setter methods. More...
 
procedure, public set_reprocessing_rate => Origen_CaseWrapper__set_reprocessing_rate
 
procedure, public set_reprocessing_rate_at => Origen_CaseWrapper__set_reprocessing_rate_at
 
procedure, public set_burnup_at => Origen_CaseWrapper__set_burnup_at
 
procedure, public set_fluence_at => Origen_CaseWrapper__set_fluence_at
 
procedure, public set_volume => Origen_CaseWrapper__set_volume
 

Public Attributes

type(origen_librarywrapper), pointer libw
 pointer to the library being used for this run More...
 
type(origen_case) b_case
 C++ class where case data is stored. More...
 
logical b_initialized = .false.
 boolean to determine intization state More...
 
real(c_double), dimension(:), allocatable times
 end-of-step times [0:nsteps] More...
 
logical input_by_flux = .false.
 switch for given flux / given power More...
 
real(c_double), dimension(:), allocatable fluxes
 given (or converted) flux [nsteps] More...
 
real(c_double), dimension(:), allocatable powers
 given (or converted) power [nsteps] More...
 
real(c_double), dimension(:), allocatable burnups
 calculated burnup [0:nsteps] More...
 
real(c_double), dimension(:), allocatable fluence
 calculated fluence [0:nsteps] More...
 
real(c_double), dimension(:,:), allocatable concentrations
 nuclide concentrations [0:nsteps,1:itot] More...
 
real(c_double), dimension(:), allocatable concentrations0
 nuclide initial concentrations [0:nsteps,1:itot]; the reason why the concentrations(0,:) array is not used directly is that it is not allocated until set_times is called More...
 
real(c_double), dimension(:), allocatable reprocessing_rate
 continuous reprocessing rate More...
 
real(c_double), dimension(:), allocatable feed_rate
 continuous feed rate More...
 
logical adjoint = .false.
 is this an adjoint case? More...
 
logical fixed_fission_energy = .false.
 switch: use fixed or composition-dependent fission energy? More...
 
real(c_double) volume = 1.0d0
 volume More...
 
real(c_double) save_time_offset = 0.0
 Set the time offset for saving to f71 (allows discharge to be time = 0): More...
 

Private Member Functions

procedure, private execute_calculation => Origen_CaseWrapper__execute_calculation
 This function performs the depletion calculation This is not a wrapper function. The associated wrapper function is run. More...
 

Private Attributes

type(solver_options), private solver
 To set/get solver options use thisb_caseset/get_solver_options() More...
 

Member Function/Subroutine Documentation

procedure, public initialize ( )

Constructor for the ORIGEN API object.

procedure, public destroy ( )

destructor

procedure, public set_times ( )

Set the time steps.

procedure, public set_fluxes ( )

Set fluxes (and say that input is done by flux).

procedure, public set_powers ( )

Set powers (and say that input is done by power).

procedure, public run ( )

Run the calculation - this methods does all that needs to be done.

procedure, public set_initial_concentrations ( )

Set the initial concentrations for the problem (ORIGEN input style).

procedure, public set_initial_concentrations_by_vector ( )

Set the initial concentrations for the problem (full concentration vector).

procedure, public set_initial_concentrations_from_concs ( )

Set the initial concentrations from concs.

procedure, public set_initial_concentrations_from_file ( )

set initial concentrations from a file

procedure, public set_feed_rates ( )

Set the feed rates for the problem (ORIGEN input style).

procedure, public set_feed_rates_by_vector ( )

Set the feed rates for the problem (full concentration vector).

procedure, public load_new_concentrations ( )

Load new concentrations from the input file arrays.

procedure, public save_states ( )

Save states of the problem.

procedure, public create_state_header ( )
procedure, public create_state ( )
procedure, public get_concentrations ( )

Get the concentrations matrix (after the calculation).

procedure, public get_concentrations_at_time ( )
procedure, public nsteps ( )

Data retriever methods.

procedure, public get_input_by_flux ( )
procedure, public get_adjoint ( )
procedure, public get_fixed_fission_energy ( )
procedure, public get_volume ( )
procedure, public get_decay_only ( )
procedure, public get_times ( )

Data retrievers for arrays.

procedure, public get_fluxes ( )
procedure, public get_powers ( )
procedure, public get_burnups ( )
procedure, public get_concentrations0 ( )
procedure, public get_reprocessing_rate ( )
procedure, public get_feed_rate ( )
procedure, public total_nuclides ( )
procedure, public times_at ( )

Single elements data retrievers (at element i or i,j)

procedure, public fluxes_at ( )
procedure, public powers_at ( )
procedure, public burnups_at ( )
procedure, public fluence_at ( )
procedure, public concentrations0_at ( )
procedure, public concentrations_at ( )
procedure, public reprocessing_rate_at ( )
procedure, public feed_rate_at ( )
procedure, public set_fixed_fission_energy ( )

Data setter methods.

procedure, public set_reprocessing_rate ( )
procedure, public set_reprocessing_rate_at ( )
procedure, public set_burnup_at ( )
procedure, public set_fluence_at ( )
procedure, public set_volume ( )
procedure, private execute_calculation ( )
private

This function performs the depletion calculation This is not a wrapper function. The associated wrapper function is run.

Member Data Documentation

type(origen_librarywrapper), pointer libw

pointer to the library being used for this run

type(origen_case) b_case

C++ class where case data is stored.

logical b_initialized = .false.

boolean to determine intization state

real(c_double), dimension(:), allocatable times

end-of-step times [0:nsteps]

logical input_by_flux = .false.

switch for given flux / given power

real(c_double), dimension(:), allocatable fluxes

given (or converted) flux [nsteps]

real(c_double), dimension(:), allocatable powers

given (or converted) power [nsteps]

real(c_double), dimension(:), allocatable burnups

calculated burnup [0:nsteps]

real(c_double), dimension(:), allocatable fluence

calculated fluence [0:nsteps]

real(c_double), dimension(:,:), allocatable concentrations

nuclide concentrations [0:nsteps,1:itot]

real(c_double), dimension(:), allocatable concentrations0

nuclide initial concentrations [0:nsteps,1:itot]; the reason why the concentrations(0,:) array is not used directly is that it is not allocated until set_times is called

type(solver_options), private solver
private

To set/get solver options use thisb_caseset/get_solver_options()

real(c_double), dimension(:), allocatable reprocessing_rate

continuous reprocessing rate

real(c_double), dimension(:), allocatable feed_rate

continuous feed rate

logical adjoint = .false.

is this an adjoint case?

logical fixed_fission_energy = .false.

switch: use fixed or composition-dependent fission energy?

real(c_double) volume = 1.0d0

volume

real(c_double) save_time_offset = 0.0

Set the time offset for saving to f71 (allows discharge to be time = 0):


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