Orcaflex

Analysis Tools

• OrcaFlex: Primary analysis engine
• OrcaWave: Wave diffraction analysis
• Python API: Automation and batch processing

Web Resources

Official Documentation

• OrcaFlex Documentation - Complete user manual and theory
• Python API Reference - Automation guide
• Example Models - Industry case studies

Standards & Guidelines

• DNV Rules & Standards - Offshore certification requirements
• API Standards - Industry best practices

Technical Resources

• Technical Papers - Validation studies and theory

Usage Examples

Basic Analysis Query

"Set up an OrcaFlex model for a turret-moored FPSO in 1500m water depth with 12 mooring lines"

Python Automation

import OrcFxAPI

model = OrcFxAPI.Model()
vessel = model.CreateObject(OrcFxAPI.otVessel, "FPSO")
# Agent will provide complete setup code

Standards Compliance

"Verify the mooring system design against DNV-ST-F201 requirements for a 100-year storm"

Workflows

Enhanced Specifications

• Auto-generates detailed analysis specifications
• Includes load cases, environmental conditions, and acceptance criteria
• Learning-enabled for continuous improvement

Analysis Automation

• Batch processing for multiple load cases
• Automated result extraction and reporting
• Parametric studies and optimization

Internal Resources

• src/modules/hydrodynamics/ - Hydrodynamic calculation modules
• specs/modules/marine-engineering/ - Engineering specifications
• context/examples_knowledge.json - Knowledge base from 54 OrcaFlex examples
• context/examples_index.json - Searchable index for finding relevant examples
• context/examples_knowledge_summary.md - Human-readable summary of examples

Examples Knowledge Base

The agent now has access to analyzed metadata from 54 official OrcaFlex examples:

• 15 unique features demonstrated (lazy wave, steep wave, SHEAR7 interface, etc.)
• Multiple analysis types covered (static, dynamic, fatigue, VIV, installation)
• Various components modeled (vessels, risers, moorings, buoys)
• Searchable index for finding relevant examples by criteria

To find examples for specific use cases:

# Query the knowledge base
import json
with open('agents/orcaflex/context/examples_index.json') as f:
    index = json.load(f)

# Find examples with risers
riser_examples = index['by_component'].get('lines', [])

# Find VIV analysis examples
viv_examples = index['by_analysis'].get('viv_analysis', [])

Resource Management

To add new resources:

python tools/manage-agent-resources.py add-link orcaflex --url "URL" --notes "Description"

To review all resources:

python tools/manage-agent-resources.py review orcaflex

Version History

• v2.0.0 (2025-08-10): Enhanced with web resources, specialized workflows, and standards compliance
• v1.0.0 (2025-08-05): Initial creation

Contact

For OrcaFlex-specific queries or to report issues with this agent, use the standard Agent OS feedback channels.

Source: BATCH_PROCESSING_NOTES.md

OrcaFlex Batch Processing - Implementation Notes

Critical Learnings from Testing (2025-08-17)

OrcaFlex API Integration

License Requirements

• OrcaFlex DLL Version Tested: 11.5e
• API Import: import OrcFxAPI
• Version Check: Use OrcFxAPI.DLLVersion() not Version()
• License Mode: Required for actual .sim file generation

File Format Compatibility

Successful Formats

• .dat files: Native OrcaFlex binary format - 100% success rate
• .yml files: YAML format - requires specific structure (see below)

YAML Structure Requirements

%YAML 1.1
# Type: Model
# Program: OrcaFlex 11.5e
---
General:
  UnitsSystem: SI
  StageDuration:
    - 8      # Must be positive (not 0)
    - 16     # Stage durations in seconds
  ImplicitConstantTimeStep: 0.1
  
Environment:
  WaterDepth: 1500.0
  Density: 1.025        # NOT WaterDensity
  SeabedModel: Elastic  # NOT Flat (options: Elastic, Nonlinear soil model)
  SeabedNormalStiffness: 100

Common YAML Errors to Avoid

1. ❌ WaterDensity → ✅ Density
2. ❌ SeabedModel: Flat → ✅ SeabedModel: Elastic
3. ❌ StageDuration: [0, 10] → ✅ StageDuration: [8, 16] (must be positive)
4. ❌ LineTypeOuterDiameter → Context not recognized in certain versions

Batch Processing Implementation

Location: src/modules/orcaflex/batch_processing/ (NOT under mooring_tension_iteration)

File Type Detection

• Batch runner includes FileTypeDetector for automatic classification
• Validates model files before processing
• Categories: OrcaFlex models, includefiles, target tensions, batch configs

Directory Structure

base_directory/
├── model_files/         # .yml, .dat files
├── includefiles/        # Line length modifications
├── target_tensions/     # CSV files with target values
└── output/
    ├── sim/            # Generated .sim files
    ├── csv/            # Results CSV files
    └── batch_report_*.txt

Batch Configuration Template

batch_info:
  name: 'Batch Run Name'
  base_directory: './path/to/models'
  output_directory: './output'
  
simulation_settings:
  analysis_type: 'statics'
  calculate_statics: true
  save_simulation_file: true
  continue_on_error: true
  parallel_processing: false  # Set true for concurrent processing
  
output_settings:
  save_simulation: true
  sim_output_folder: 'sim'
  csv_output_folder: 'csv'