!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> A Module For Storing The Parameters For Iterative Solvers. MODULE SolverParametersModule USE DataTypesModule, ONLY : NTREAL USE LoggingModule, ONLY : EnterSubLog, ExitSubLog, WriteElement, & & WriteHeader USE PermutationModule, ONLY : Permutation_t, DestructPermutation IMPLICIT NONE PRIVATE !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> A class for passing parameters to an iterative solver. TYPE, PUBLIC :: SolverParameters_t !> When do we consider a calculation converged. REAL(NTREAL) :: converge_diff !> Maximum number of iterations of a solver before termination. INTEGER :: max_iterations !> Threshold for sparse multiplication and addition. REAL(NTREAL) :: threshold !> If true, the sparse solver prints out information each loop iteration. LOGICAL :: be_verbose !> If true, the sparse solver will try and load balance before calculation. LOGICAL :: do_load_balancing !> The permutation used for load balancing. TYPE(Permutation_t) :: BalancePermutation END TYPE SolverParameters_t !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! INTERFACE SolverParameters_t MODULE PROCEDURE SolverParameters_init END INTERFACE !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! PUBLIC :: SetParametersConvergeDiff PUBLIC :: SetParametersMaxIterations PUBLIC :: SetParametersThreshold PUBLIC :: SetParametersBeVerbose PUBLIC :: SetParametersLoadBalance PUBLIC :: PrintParameters PUBLIC :: DestructSolverParameters !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> The default convergence difference. REAL(NTREAL), PARAMETER, PUBLIC :: CONVERGENCE_DIFF_CONST = 1e-6 !> The default maximum number of iterations. INTEGER, PARAMETER, PUBLIC :: MAX_ITERATIONS_CONST = 1000 CONTAINS!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Construct a data type which stores iterative solver parameters. PURE FUNCTION SolverParameters_init(converge_diff_in, threshold_in, & & max_iterations_in, be_verbose_in, BalancePermutation_in) RESULT(this) !> Converge_diff_in the difference between iterations to consider !> a calculation converged. REAL(NTREAL), INTENT(IN), OPTIONAL :: converge_diff_in !> The zero threshold REAL(NTREAL), INTENT(IN), OPTIONAL :: threshold_in !> The maximum number of iterations to perform INTEGER, INTENT(IN), OPTIONAL :: max_iterations_in !> Whether to print during the calculation (default = False) LOGICAL, INTENT(IN), OPTIONAL :: be_verbose_in !> For load balancing TYPE(Permutation_t), INTENT(IN), OPTIONAL :: BalancePermutation_in TYPE(SolverParameters_t) :: this !! Optional Parameters IF (.NOT. PRESENT(converge_diff_in)) THEN this%converge_diff = CONVERGENCE_DIFF_CONST ELSE this%converge_diff = converge_diff_in END IF IF (.NOT. PRESENT(threshold_in)) THEN this%threshold = 0.0 ELSE this%threshold = threshold_in END IF IF (.NOT. PRESENT(max_iterations_in)) THEN this%max_iterations = MAX_ITERATIONS_CONST ELSE this%max_iterations = max_iterations_in END IF IF (.NOT. PRESENT(be_verbose_in)) THEN this%be_verbose = .FALSE. ELSE this%be_verbose = be_verbose_in END IF IF (.NOT. PRESENT(BalancePermutation_in)) THEN this%do_load_balancing = .FALSE. ELSE this%do_load_balancing = .TRUE. this%BalancePermutation = BalancePermutation_in END IF END FUNCTION SolverParameters_init !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Set the value of the convergence difference. PURE SUBROUTINE SetParametersConvergeDiff(this,new_value) !> The parameter object. TYPE(SolverParameters_t), INTENT(INOUT) :: this !> Value to set it to. REAL(NTREAL), INTENT(IN) :: new_value this%converge_diff = new_value END SUBROUTINE SetParametersConvergeDiff !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Set the value of the max iterations. PURE SUBROUTINE SetParametersMaxIterations(this,new_value) !> The parameter object. TYPE(SolverParameters_t), INTENT(INOUT) :: this !> Value to set it to. INTEGER, INTENT(IN) :: new_value this%max_iterations = new_value END SUBROUTINE SetParametersMaxIterations !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Set the value of the threshold. PURE SUBROUTINE SetParametersThreshold(this,new_value) !> The parameter object. TYPE(SolverParameters_t), INTENT(INOUT) :: this !> Value to set it to. REAL(NTREAL), INTENT(IN) :: new_value this%threshold = new_value END SUBROUTINE SetParametersThreshold !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Set the value of the verbosity. PURE SUBROUTINE SetParametersBeVerbose(this,new_value) !> The parameter object. TYPE(SolverParameters_t), INTENT(INOUT) :: this !> Value to set it to. LOGICAL, INTENT(IN) :: new_value this%be_verbose = new_value END SUBROUTINE SetParametersBeVerbose !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Set the value of the load balance. PURE SUBROUTINE SetParametersLoadBalance(this,new_value) !> The parameter object. TYPE(SolverParameters_t), INTENT(INOUT) :: this !> Value to set it to. TYPE(Permutation_t), INTENT(IN) :: new_value this%do_load_balancing = .TRUE. this%BalancePermutation = new_value END SUBROUTINE SetParametersLoadBalance !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Print out the iterative solver parameter values. SUBROUTINE PrintParameters(this) !> The parameter object. TYPE(SolverParameters_t), INTENT(IN) :: this CALL WriteHeader("Solver Parameters") CALL EnterSubLog CALL WriteElement(key="be_verbose", value=this%be_verbose) CALL WriteElement(key="do_load_balancing", value=this%do_load_balancing) CALL WriteElement(key="converge_diff", value=this%converge_diff) CALL WriteElement(key="threshold", value=this%threshold) CALL WriteElement(key="max_iterations", value=this%max_iterations) CALL ExitSubLog END SUBROUTINE PrintParameters !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !> Cleanup the solver parameters datastructure. PURE SUBROUTINE DestructSolverParameters(this) !> The parameter object. TYPE(SolverParameters_t), INTENT(INOUT) :: this CALL DestructPermutation(this%BalancePermutation) END SUBROUTINE DestructSolverParameters !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! END MODULE SolverParametersModule