ResInsight/ApplicationLibCode/Application/RiaPreferencesBatch.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2026     Equinor ASA
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#include "RiaPreferencesBatch.h"

#include "Hpc/RiaHpcTools.h"
#include "RiaApplication.h"
#include "RiaPreferences.h"
#include "RiaPreferencesOpm.h"

#include "cafPdmUiCheckBoxEditor.h"
#include "cafPdmUiComboBoxEditor.h"

#include <QInputDialog>

CAF_PDM_SOURCE_INIT( RiaPreferencesBatch, "RiaPreferencesBatch" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaPreferencesBatch::RiaPreferencesBatch()
{
    CAF_PDM_InitField( &m_maxParallelJobs, "maxParallelJobs", (size_t)1, "Maximum number of jobs to run in parallel on local machine" );
    m_maxParallelJobs.setRange( 1, 100 );

    CAF_PDM_InitFieldNoDefault( &m_batchScheduler, "batchScheduler", "Batch Scheduler to use for submitting jobs" );
    CAF_PDM_InitField( &m_exclusive, "exclusive", false, "Exclusive - do not share assigned nodes with other jobs." );
    caf::PdmUiNativeCheckBoxEditor::configureFieldForEditor( &m_exclusive );

    CAF_PDM_InitFieldNoDefault( &m_batchJobMonitoring, "jobMonitoring", "Job Completion Check" );

    CAF_PDM_InitFieldNoDefault( &m_queueName, "queueName", "Default queue/partition name" );

    CAF_PDM_InitField( &m_updateInterval, "pollUpdateInterval", 10, "Job Status Polling Interval" );
    m_updateInterval.uiCapability()->setUiEditorTypeName( caf::PdmUiComboBoxEditor::uiEditorTypeName() );

    CAF_PDM_InitField( &m_submitWaitSeconds,
                       "submitWaitSeconds",
                       4,
                       "Time to Wait After Job Submit (seconds)",
                       "",
                       "Wait at least this many seconds before assuming a job not in the job list has been completed." );
    m_submitWaitSeconds.setRange( 0, 120 );

    CAF_PDM_InitFieldNoDefault( &m_additionalLsfOptions, "additionalLsfOptions", "" );
    CAF_PDM_InitFieldNoDefault( &m_additionalSlurmOptions, "additionalSlurmOptions", "" );
    m_additionalLsfOptions.uiCapability()->setUiLabelPosition( caf::PdmUiItemInfo::LabelPosition::HIDDEN );
    m_additionalSlurmOptions.uiCapability()->setUiLabelPosition( caf::PdmUiItemInfo::LabelPosition::HIDDEN );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaPreferencesBatch* RiaPreferencesBatch::current()
{
    return RiaApplication::instance()->preferences()->batchPreferences();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RiaPreferencesBatch::appendItems( caf::PdmUiOrdering& uiOrdering )
{
    caf::PdmUiGroup* genGrp = uiOrdering.addNewGroup( "General Settings" );
    genGrp->add( &m_batchScheduler );

    if ( m_batchScheduler() == RiaDefines::BatchSchedulerType::LOCAL_COMPUTER )
    {
        auto localGrp = uiOrdering.addNewGroup( "Local Computer Options" );
        localGrp->add( &m_maxParallelJobs );
    }
    else
    {
        uiOrdering.addNewLabel( "NOTE: This functionality should be considered BETA as it is still under development." );

        auto hpcGrp = uiOrdering.addNewGroup( "Batch Scheduler Options" );
        hpcGrp->add( &m_queueName );

        hpcGrp->addNewButton( "Select...",
                              [this]()
                              {
                                  auto newName = RiaPreferencesBatch::selectQueue( m_batchScheduler(), m_queueName() );
                                  m_queueName.setValueWithFieldChanged( newName );
                              },
                              { .newRow = false, .totalColumnSpan = 1 } );
        hpcGrp->add( &m_exclusive );
        if ( m_batchScheduler() == RiaDefines::BatchSchedulerType::LSF )
        {
            hpcGrp->addNewLabel( "Additional LSF options can be specified here. For example: -R \"select[x86_64Linux] span[ptile=4]\"" );
            hpcGrp->add( &m_additionalLsfOptions );
        }
        else if ( m_batchScheduler() == RiaDefines::BatchSchedulerType::SLURM )
        {
            hpcGrp->addNewLabel( "Additional Slurm options can be specified here. For example: --mem=1G" );
            hpcGrp->add( &m_additionalSlurmOptions );
        }
        hpcGrp->add( &m_batchJobMonitoring );
        hpcGrp->add( &m_updateInterval );

        if ( m_batchJobMonitoring() == RiaDefines::BatchJobMonitoringType::QUEUE_POLLING )
        {
            hpcGrp->add( &m_submitWaitSeconds );
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
size_t RiaPreferencesBatch::maxParallelJobs() const
{
    return m_maxParallelJobs();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaDefines::BatchSchedulerType RiaPreferencesBatch::batchScheduler() const
{
    return m_batchScheduler();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaDefines::BatchJobMonitoringType RiaPreferencesBatch::jobMonitoring() const
{
    return m_batchJobMonitoring();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RiaPreferencesBatch::queueName() const
{
    return m_queueName();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RiaPreferencesBatch::batchSchedulerOptions() const
{
    if ( m_batchScheduler() == RiaDefines::BatchSchedulerType::LSF )
    {
        return m_additionalLsfOptions();
    }
    else if ( m_batchScheduler() == RiaDefines::BatchSchedulerType::SLURM )
    {
        return m_additionalSlurmOptions();
    }
    return "";
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RiaPreferencesBatch::exclusiveJob() const
{
    return m_exclusive();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RiaPreferencesBatch::selectQueue( RiaDefines::BatchSchedulerType scheduler, QString currentQueue )
{
    QStringList queues    = RiaHpcTools::availableQueues( scheduler, RiaPreferencesOpm::current()->wslOptions() );
    QString     labelText = "Available Queues/Partitions:";
    if ( queues.isEmpty() )
    {
        labelText = "Warning: failed to get available queues/partitions.";
        queues.append( currentQueue );
    }

    int currentQueueIndex = currentQueue.isEmpty() ? 0 : queues.indexOf( currentQueue );

    bool    ok;
    QString selectedQueue = QInputDialog::getItem( nullptr, "Select Queue/Partition", labelText, queues, currentQueueIndex, false, &ok );
    if ( ok && !selectedQueue.isEmpty() )
    {
        return selectedQueue;
    }
    return currentQueue;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QList<caf::PdmOptionItemInfo> RiaPreferencesBatch::calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions )
{
    QList<caf::PdmOptionItemInfo> options;

    if ( fieldNeedingOptions == &m_updateInterval )
    {
        options.push_back( caf::PdmOptionItemInfo( "5 seconds", QVariant::fromValue( 5 ) ) );
        options.push_back( caf::PdmOptionItemInfo( "10 seconds", QVariant::fromValue( 10 ) ) );
        options.push_back( caf::PdmOptionItemInfo( "30 seconds", QVariant::fromValue( 30 ) ) );
    }

    return options;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
int RiaPreferencesBatch::secondsToWaitForSubmit() const
{
    return m_submitWaitSeconds();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
int RiaPreferencesBatch::statusRefreshInterval() const
{
    return m_updateInterval();
}