#14772 Forward scaleFractureTemplate to RimcFractureTemplate_setScaleFactors

Add a typed setter to the existing RimcFractureTemplate_setScaleFactors
object method and let RicfScaleFractureTemplate forward to it via
RicfForwarding::findFractureTemplate(). Make RimFractureTemplate::m_id
scriptable (read-only) so templates can be looked up by id from Python.

Project.scale_fracture_template(template_id=...) in Python now resolves
the template object and calls FractureTemplate.set_scale_factors(),
emitting a DeprecationWarning.
This commit is contained in:
Kristian Bendiksen committed 2026-09-22 14:19:23 +02:00
1 parent dbd9e50f5f
commit eda2d73fed
6 files changed
+135 -46

No files matched your search

@@ -19,11 +19,10 @@
#include "RicfScaleFractureTemplate.h"
#include "RiaLogging.h"
#include "RicfCommandForwarding.h"
#include "RimFractureTemplate.h"
#include "RimFractureTemplateCollection.h"
#include "RimProject.h"
#include "RimcFractureTemplate.h"
#include "cafPdmFieldScriptingCapability.h"
@@ -48,36 +47,17 @@ RicfScaleFractureTemplate::RicfScaleFractureTemplate()
//--------------------------------------------------------------------------------------------------
caf::PdmScriptResponse RicfScaleFractureTemplate::execute()
{
if ( m_id < 0 )
{
QString error( "scaleFractureTemplate: Fracture template id not specified" );
RiaLogging::error( error.toStdString() );
return caf::PdmScriptResponse( caf::PdmScriptResponse::COMMAND_ERROR, error );
}
const QString commandName = classKeyword();
RimProject* project = RimProject::current();
if ( m_id < 0 ) return RicfForwarding::errorResponse( "Fracture template id not specified", commandName );
if ( !project )
{
QString error( "scaleFractureTemplate: Project not found" );
RiaLogging::error( error.toStdString() );
return caf::PdmScriptResponse( caf::PdmScriptResponse::COMMAND_ERROR, error );
}
auto fractureTemplate = RicfForwarding::findFractureTemplate( m_id() );
if ( !fractureTemplate ) return RicfForwarding::errorResponse( fractureTemplate.error(), commandName );
RimFractureTemplateCollection* templColl =
!project->allFractureTemplateCollections().empty() ? project->allFractureTemplateCollections()[0] : nullptr;
RimFractureTemplate* templ = templColl ? templColl->fractureTemplate( m_id ) : nullptr;
RimcFractureTemplate_setScaleFactors method( fractureTemplate.value() );
method.setScaleFactors( m_halfLengthScaleFactor(), m_heightScaleFactor(), m_dFactorScaleFactor(), m_conductivityScaleFactor() );
if ( !templ )
{
QString error = QString( "scaleFractureTemplate: Fracture template not found. Id=%1" ).arg( m_id() );
RiaLogging::error( error.toStdString() );
return caf::PdmScriptResponse( caf::PdmScriptResponse::COMMAND_ERROR, error );
}
templ->setScaleFactors( m_halfLengthScaleFactor, m_heightScaleFactor, m_dFactorScaleFactor, m_conductivityScaleFactor );
templ->loadDataAndUpdateGeometryHasChanged();
return caf::PdmScriptResponse();
return RicfForwarding::toScriptResponse( method.execute(), commandName );
}
//--------------------------------------------------------------------------------------------------
@@ -109,7 +109,7 @@ RimFractureTemplate::RimFractureTemplate()
{
CAF_PDM_InitScriptableObject( "Fracture Template", ":/FractureTemplate16x16.png" );
CAF_PDM_InitField( &m_id, "Id", -1, "ID" );
CAF_PDM_InitScriptableField( &m_id, "Id", -1, "ID" );
m_id.uiCapability()->setUiReadOnly( true );
CAF_PDM_InitScriptableField( &m_name, "UserDescription", QString( "Fracture Template" ), "Name" );
@@ -40,6 +40,17 @@ RimcFractureTemplate_setScaleFactors::RimcFractureTemplate_setScaleFactors( caf:
CAF_PDM_InitScriptableField( &m_conductivity, "Conductivity", 1.0, "Conductivity" );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimcFractureTemplate_setScaleFactors::setScaleFactors( double halfLength, double height, double dFactor, double conductivity )
{
m_halfLength = halfLength;
m_height = height;
m_dFactor = dFactor;
m_conductivity = conductivity;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
@@ -59,3 +70,44 @@ std::expected<caf::PdmObjectHandle*, QString> RimcFractureTemplate_setScaleFacto
return nullptr;
}
CAF_PDM_OBJECT_METHOD_SOURCE_INIT( RimFractureTemplate, RimFractureTemplate_setContainment, "setContainment" );
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimFractureTemplate_setContainment::RimFractureTemplate_setContainment( caf::PdmObjectHandle* self )
: caf::PdmVoidObjectMethod( self )
{
CAF_PDM_InitObject( "Set Fracture Containment", "", "", "Set the K layer range fractures from this template are contained within" );
CAF_PDM_InitScriptableField( &m_topLayer, "TopLayer", -1, "Top Layer", "", "", "Zero-based K index of the top layer" );
CAF_PDM_InitScriptableField( &m_baseLayer, "BaseLayer", -1, "Base Layer", "", "", "Zero-based K index of the base layer" );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimFractureTemplate_setContainment::setLayers( int topLayer, int baseLayer )
{
m_topLayer = topLayer;
m_baseLayer = baseLayer;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::expected<caf::PdmObjectHandle*, QString> RimFractureTemplate_setContainment::execute()
{
auto* fractureTemplate = self<RimFractureTemplate>();
if ( !fractureTemplate ) return std::unexpected( "No fracture template is available." );
if ( m_topLayer() < 0 || m_baseLayer() < 0 ) return std::unexpected( "Top and base layer must be non-negative." );
if ( m_topLayer() > m_baseLayer() ) return std::unexpected( "Top layer must not be below the base layer." );
fractureTemplate->setContainmentTopKLayer( m_topLayer() );
fractureTemplate->setContainmentBaseKLayer( m_baseLayer() );
fractureTemplate->loadDataAndUpdateGeometryHasChanged();
return nullptr;
}
@@ -36,6 +36,8 @@ class RimcFractureTemplate_setScaleFactors : public caf::PdmVoidObjectMethod
public:
RimcFractureTemplate_setScaleFactors( caf::PdmObjectHandle* self );
void setScaleFactors( double halfLength, double height, double dFactor, double conductivity );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
private:
@@ -44,3 +46,22 @@ private:
caf::PdmField<double> m_dFactor;
caf::PdmField<double> m_conductivity;
};
//==================================================================================================
/// Set the K layer range the fractures created from this template are contained within.
//==================================================================================================
class RimFractureTemplate_setContainment : public caf::PdmVoidObjectMethod
{
CAF_PDM_HEADER_INIT;
public:
RimFractureTemplate_setContainment( caf::PdmObjectHandle* self );
void setLayers( int topLayer, int baseLayer );
std::expected<caf::PdmObjectHandle*, QString> execute() override;
private:
caf::PdmField<int> m_topLayer;
caf::PdmField<int> m_baseLayer;
};