Data Types
type	imslinearsettingstype

Enumerations
enum
	IMS linear preconditioner types. More...

Functions/Subroutines
subroutine	init (this, mem_path)

subroutine	preset_config (this, idfparam)
	Set solver pre-configured settings based on complexity option. More...

subroutine	read_from_file (this, parser, iout)
	Read the settings for the linear solver from the .ims file,. More...

subroutine	check_settings (this)
	Check the settings after reading the configuration from file. More...

subroutine	destroy (this)

pure integer(i4b) function, public	resolve_ipc (level, relax)
	Resolve the preconditioner enum from the ILU controls. More...

Variables
integer(i4b), parameter, public	cg_method = 1

integer(i4b), parameter, public	bcgs_method = 2

@, public	ipc_unknown = 0
	preconditioner type not set More...

@, public	ipc_ilu0 = 1
	ILU0 (incomplete LU, zero fill) More...

@, public	ipc_milu0 = 2
	modified ILU0 More...

@, public	ipc_ilut = 3
	ILUT (incomplete LU with threshold) More...

@, public	ipc_milut = 4
	modified ILUT More...

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

private

Definition at line 15 of file ImsLinearSettings.f90.

Function/Subroutine Documentation

◆ check_settings()

subroutine imslinearsettingsmodule::check_settings ( class(imslinearsettingstype) this )

private

Parameters

this	linear settings

Definition at line 270 of file ImsLinearSettings.f90.

     class(ImsLinearSettingsType) :: this !< linear settings
     ! local
     character(len=LINELENGTH) :: warnmsg
  
     if (this%level == 0 .and. this%droptol > 0.0_dp) then
       write (warnmsg, '(a)') "PRECONDITIONER_DROP_TOLERANCE is ignored because &
                              &PRECONDITIONER_LEVELS equals zero."
       call store_warning(warnmsg)
     end if
  

Here is the call graph for this function:

◆ destroy()

subroutine imslinearsettingsmodule::destroy ( class(imslinearsettingstype) this )

private

Parameters

this	linear settings

Definition at line 283 of file ImsLinearSettings.f90.

     class(ImsLinearSettingsType) :: this !< linear settings
  
     call mem_deallocate(this%dvclose)
     call mem_deallocate(this%rclose)
     call mem_deallocate(this%icnvgopt)
     call mem_deallocate(this%iter1)
     call mem_deallocate(this%ilinmeth)
     call mem_deallocate(this%iscl)
     call mem_deallocate(this%iord)
     call mem_deallocate(this%north)
     call mem_deallocate(this%relax)
     call mem_deallocate(this%level)
     call mem_deallocate(this%droptol)
     call mem_deallocate(this%ifdparam)
  

◆ init()

subroutine imslinearsettingsmodule::init	(	class(imslinearsettingstype)	this,
		character(len=lenmempath)	mem_path
	)

Parameters

this	linear settings
mem_path	solution memory path

Definition at line 49 of file ImsLinearSettings.f90.

     use memoryhelpermodule, only: create_mem_path
     class(ImsLinearSettingsType) :: this !< linear settings
     character(len=LENMEMPATH) :: mem_path !< solution memory path
  
     this%memory_path = create_mem_path(mem_path, 'IMSLINEAR')
  
     call mem_allocate(this%dvclose, 'DVCLOSE', this%memory_path)
     call mem_allocate(this%rclose, 'RCLOSE', this%memory_path)
     call mem_allocate(this%icnvgopt, 'ICNVGOPT', this%memory_path)
     call mem_allocate(this%iter1, 'ITER1', this%memory_path)
     call mem_allocate(this%ilinmeth, 'ILINMETH', this%memory_path)
     call mem_allocate(this%iscl, 'ISCL', this%memory_path)
     call mem_allocate(this%iord, 'IORD', this%memory_path)
     call mem_allocate(this%north, 'NORTH', this%memory_path)
     call mem_allocate(this%relax, 'RELAX', this%memory_path)
     call mem_allocate(this%level, 'LEVEL', this%memory_path)
     call mem_allocate(this%droptol, 'DROPTOL', this%memory_path)
     call mem_allocate(this%ifdparam, 'IDFPARAM', this%memory_path)
  
     ! defaults
     this%dvclose = dzero
     this%rclose = dzero
     this%icnvgopt = 0
     this%iter1 = 0
     this%ilinmeth = 0
     this%iscl = 0
     this%iord = 0
     this%north = 0
     this%relax = dzero
     this%level = 0
     this%droptol = dzero
     this%ifdparam = 0
  

Here is the call graph for this function:

◆ preset_config()

subroutine imslinearsettingsmodule::preset_config	(	class(imslinearsettingstype)	this,
		integer(i4b)	idfparam
	)

Parameters

this	linear settings
idfparam	complexity option

Definition at line 87 of file ImsLinearSettings.f90.

     class(ImsLinearSettingsType) :: this !< linear settings
     integer(I4B) :: idfparam !< complexity option
  
     this%ifdparam = idfparam
  
     select case (idfparam)
     case (1) ! Simple option
       this%iter1 = 50
       this%ilinmeth = 1
       this%iscl = 0
       this%iord = 0
       this%dvclose = dem3
       this%rclose = dem1
       this%relax = dzero
       this%level = 0
       this%droptol = dzero
       this%north = 0
     case (2) ! Moderate
       this%iter1 = 100
       this%ilinmeth = 2
       this%iscl = 0
       this%iord = 0
       this%dvclose = dem2
       this%rclose = dem1
       this%relax = 0.97d0
       this%level = 0
       this%droptol = dzero
       this%north = 0
     case (3) ! Complex
       this%iter1 = 500
       this%ilinmeth = 2
       this%iscl = 0
       this%iord = 0
       this%dvclose = dem1
       this%rclose = dem1
       this%relax = dzero
       this%level = 5
       this%droptol = dem4
       this%north = 2
     end select
  

◆ read_from_file()

subroutine imslinearsettingsmodule::read_from_file	(	class(imslinearsettingstype)	this,
		type(blockparsertype)	parser,
		integer(i4b)	iout
	)

private

Parameters

this	linear settings
parser	block parser
iout	listing file

Definition at line 133 of file ImsLinearSettings.f90.

     class(ImsLinearSettingsType) :: this !< linear settings
     type(BlockParserType) :: parser !< block parser
     integer(I4B) :: iout !< listing file
     ! local
     logical(LGP) :: block_found, end_of_block
     integer(I4B) :: ierr
     character(len=LINELENGTH) :: errmsg
     character(len=LINELENGTH) :: warnmsg
     character(len=LINELENGTH) :: keyword
     integer(I4B) :: iscaling, iordering
  
     call parser%GetBlock('LINEAR', block_found, ierr, supportopenclose=.true., &
                          blockrequired=.false.)
  
     if (block_found) then
       write (iout, '(/1x,a)') 'PROCESSING LINEAR DATA'
       do
         call parser%GetNextLine(end_of_block)
         if (end_of_block) exit
         call parser%GetStringCaps(keyword)
         ! -- parse keyword
         select case (keyword)
         case ('INNER_DVCLOSE')
           this%dvclose = parser%GetDouble()
         case ('INNER_RCLOSE')
           this%rclose = parser%GetDouble()
           ! -- look for additional key words
           call parser%GetStringCaps(keyword)
           if (keyword == 'STRICT') then
             this%icnvgopt = 1
           else if (keyword == 'L2NORM_RCLOSE') then
             this%icnvgopt = 2
           else if (keyword == 'RELATIVE_RCLOSE') then
             this%icnvgopt = 3
           else if (keyword == 'L2NORM_RELATIVE_RCLOSE') then
             this%icnvgopt = 4
           end if
         case ('INNER_MAXIMUM')
           this%iter1 = parser%GetInteger()
         case ('LINEAR_ACCELERATION')
           call parser%GetStringCaps(keyword)
           if (keyword .eq. 'CG') then
             this%ilinmeth = 1
           else if (keyword .eq. 'BICGSTAB') then
             this%ilinmeth = 2
           else
             this%ilinmeth = 0
             write (errmsg, '(3a)') &
               'Unknown IMSLINEAR LINEAR_ACCELERATION method (', &
               trim(keyword), ').'
             call store_error(errmsg)
           end if
         case ('SCALING_METHOD')
           call parser%GetStringCaps(keyword)
           iscaling = 0
           if (keyword .eq. 'NONE') then
             iscaling = 0
           else if (keyword .eq. 'DIAGONAL') then
             iscaling = 1
           else if (keyword .eq. 'L2NORM') then
             iscaling = 2
           else
             write (errmsg, '(3a)') &
               'Unknown IMSLINEAR SCALING_METHOD (', trim(keyword), ').'
             call store_error(errmsg)
           end if
           this%iscl = iscaling
         case ('RED_BLACK_ORDERING')
           iordering = 0
         case ('REORDERING_METHOD')
           call parser%GetStringCaps(keyword)
           iordering = 0
           if (keyword == 'NONE') then
             iordering = 0
           else if (keyword == 'RCM') then
             iordering = 1
           else if (keyword == 'MD') then
             iordering = 2
           else
             write (errmsg, '(3a)') &
               'Unknown IMSLINEAR REORDERING_METHOD (', trim(keyword), ').'
             call store_error(errmsg)
           end if
           this%iord = iordering
         case ('NUMBER_ORTHOGONALIZATIONS')
           this%north = parser%GetInteger()
         case ('RELAXATION_FACTOR')
           this%relax = parser%GetDouble()
         case ('PRECONDITIONER_LEVELS')
           this%level = parser%GetInteger()
           if (this%level < 0) then
             write (errmsg, '(a,1x,a)') &
               'IMSLINEAR PRECONDITIONER_LEVELS must be greater than', &
               'or equal to zero'
             call store_error(errmsg)
           end if
         case ('PRECONDITIONER_DROP_TOLERANCE')
           this%droptol = parser%GetDouble()
           if (this%droptol < dzero) then
             write (errmsg, '(a,1x,a)') &
               'IMSLINEAR PRECONDITIONER_DROP_TOLERANCE', &
               'must be greater than or equal to zero'
             call store_error(errmsg)
           end if
           !
           ! -- deprecated variables
         case ('INNER_HCLOSE')
           this%dvclose = parser%GetDouble()
           !
           ! -- create warning message
           write (warnmsg, '(a)') &
             'SETTING INNER_DVCLOSE TO INNER_HCLOSE VALUE'
           !
           ! -- create deprecation warning
           call deprecation_warning('LINEAR', 'INNER_HCLOSE', '6.1.1', &
                                    warnmsg, parser%GetUnit())
           !
           ! -- default
         case default
           write (errmsg, '(3a)') &
             'Unknown IMSLINEAR keyword (', trim(keyword), ').'
           call store_error(errmsg)
         end select
       end do
       write (iout, '(1x,a)') 'END OF LINEAR DATA'
     else
       if (this%ifdparam == 0) THEN
         write (errmsg, '(a)') 'NO LINEAR block detected.'
         call store_error(errmsg)
       end if
     end if
  

Here is the call graph for this function:

◆ resolve_ipc()

pure integer(i4b) function, public imslinearsettingsmodule::resolve_ipc	(	integer(i4b), intent(in)	level,
		real(dp), intent(in)	relax
	)

Maps the ILU fill level and relaxation factor to a specific IPC_* preconditioner: level > 0 -> IPC_ILUT (-> IPC_MILUT when relax > 0) level == 0 -> IPC_ILU0 (-> IPC_MILU0 when relax > 0)

Extracted into a pure function so the same resolution can be reused when preconditioner settings change at runtime (e.g. by stress period).

Parameters

[in]	level	ILU fill level
[in]	relax	relaxation factor (> 0 selects the modified ILU)

Returns: resolved preconditioner enum (IPC_*)

Definition at line 311 of file ImsLinearSettings.f90.

     integer(I4B), intent(in) :: level !< ILU fill level
     real(DP), intent(in) :: relax !< relaxation factor (> 0 selects the modified ILU)
     integer(I4B) :: ipc !< resolved preconditioner enum (IPC_*)
     !
     ! -- map explicitly to the target enum (do not rely on IPC_* being
     !    consecutive); relax > 0 selects the modified variant
     if (level > 0) then
       if (relax > dzero) then
         ipc = ipc_milut
       else
         ipc = ipc_ilut
       end if
     else
       if (relax > dzero) then
         ipc = ipc_milu0
       else
         ipc = ipc_ilu0
       end if
     end if

Here is the caller graph for this function:

Variable Documentation

◆ bcgs_method

integer(i4b), parameter, public imslinearsettingsmodule::bcgs_method = 2

Definition at line 11 of file ImsLinearSettings.f90.

11 integer(I4B), public, parameter :: BCGS_METHOD = 2

◆ cg_method

integer(i4b), parameter, public imslinearsettingsmodule::cg_method = 1

Definition at line 10 of file ImsLinearSettings.f90.

10 integer(I4B), public, parameter :: CG_METHOD = 1

◆ ipc_ilu0

@, public imslinearsettingsmodule::ipc_ilu0 = 1

Definition at line 17 of file ImsLinearSettings.f90.

17 enumerator :: IPC_ILU0 = 1 !< ILU0 (incomplete LU, zero fill)

◆ ipc_ilut

@, public imslinearsettingsmodule::ipc_ilut = 3

Definition at line 19 of file ImsLinearSettings.f90.

19 enumerator :: IPC_ILUT = 3 !< ILUT (incomplete LU with threshold)

◆ ipc_milu0

@, public imslinearsettingsmodule::ipc_milu0 = 2

Definition at line 18 of file ImsLinearSettings.f90.

18 enumerator :: IPC_MILU0 = 2 !< modified ILU0

◆ ipc_milut

@, public imslinearsettingsmodule::ipc_milut = 4

Definition at line 20 of file ImsLinearSettings.f90.

20 enumerator :: IPC_MILUT = 4 !< modified ILUT

◆ ipc_unknown

@, public imslinearsettingsmodule::ipc_unknown = 0

Definition at line 16 of file ImsLinearSettings.f90.

16 enumerator :: IPC_UNKNOWN = 0 !< preconditioner type not set

Data Types

Enumerations

Functions/Subroutines

Variables

Enumeration Type Documentation

◆ anonymous enum

Function/Subroutine Documentation

◆ check_settings()

◆ destroy()

◆ init()

◆ preset_config()

◆ read_from_file()

◆ resolve_ipc()

Variable Documentation

◆ bcgs_method

◆ cg_method

◆ ipc_ilu0

◆ ipc_ilut

◆ ipc_milu0

◆ ipc_milut

◆ ipc_unknown