ar_interface Module

Legacy residual Helmholtz callbacks

Procedure-pointer interfaces used by the deprecated global-state EOS code.

Description

ar_fun points to a residual Helmholtz routine and vinit points to a liquid-volume initializer. New applications should use concrete ArModel types instead of assigning these global pointers.

Examples

ar_fun => my_residual_helmholtz
vinit => my_volume_initializer

Uses

  • module~~ar_interface~~UsesGraph module~ar_interface ar_interface iso_fortran_env iso_fortran_env module~ar_interface->iso_fortran_env module~yaeos__constants yaeos__constants module~ar_interface->module~yaeos__constants module~yaeos__constants->iso_fortran_env

Used by

  • module~~ar_interface~~UsedByGraph module~ar_interface ar_interface module~legacy_ar_models legacy_ar_models module~legacy_ar_models->module~ar_interface module~legacy_thermo_properties legacy_thermo_properties module~legacy_thermo_properties->module~legacy_ar_models

Variables

Type Visibility Attributes Name Initial
procedure(Ares), public, pointer :: ar_fun

Legacy residual Helmholtz callback pointer.

procedure(initial_volume), public, pointer :: vinit

Legacy initial-volume callback pointer.


Abstract Interfaces

abstract interface

  • public subroutine Ares(z, v, t, Ar, ArV, ArTV, ArV2, Arn, ArVn, ArTn, Arn2)

    Ares

    Callback interface for legacy residual Helmholtz models.

    Description

    Calculates the residual Helmholtz energy and derivative outputs consumed by the legacy property routines.

    Arguments

    Type IntentOptional Attributes Name
    real(kind=pr), intent(in) :: z(:)

    Component mole amounts.

    real(kind=pr), intent(in) :: v

    Total volume [L].

    real(kind=pr), intent(in) :: t

    Temperature [K].

    real(kind=pr), intent(out) :: Ar

    Residual Helmholtz energy.

    real(kind=pr), intent(out) :: ArV

    Volume derivative of residual Helmholtz energy.

    real(kind=pr), intent(out) :: ArTV

    Mixed temperature/volume derivative of residual Helmholtz energy.

    real(kind=pr), intent(out) :: ArV2

    Second volume derivative of residual Helmholtz energy.

    real(kind=pr), intent(out), dimension(size(z)) :: Arn

    Mole-number gradient of residual Helmholtz energy.

    real(kind=pr), intent(out), dimension(size(z)) :: ArVn

    Mixed volume/mole-number derivative of residual Helmholtz energy.

    real(kind=pr), intent(out), dimension(size(z)) :: ArTn

    Mixed temperature/mole-number derivative of residual Helmholtz energy.

    real(kind=pr), intent(out) :: Arn2(size(z),size(z))

    Composition Hessian.

abstract interface

  • public function initial_volume(z, p, t)

    initial_volume

    Return an initial volume estimate for a legacy pressure solve.

    Arguments

    Type IntentOptional Attributes Name
    real(kind=pr) :: z(:)

    Component mole amounts.

    real(kind=pr) :: p

    Pressure [bar].

    real(kind=pr) :: t

    Temperature [K].

    Return Value real(kind=pr)

    Initial total volume [L].