[!WARNING]
Part of the Python API documented below does not exist in
digitalmodel. These snippets are a specification of intended
capability, not runnable code. Do not import them, and do not report
a result obtained by pretending they ran.
Absent as of this revision:
digitalmodel.orcawave.damping
digitalmodel.orcawave.damping.BilgeKeelDamping
digitalmodel.orcawave.damping.CriticalDampingCalculator
digitalmodel.orcawave.damping.DampingPeriodAnalyzer
digitalmodel.orcawave.damping.DampingSweep
digitalmodel.orcawave.damping.ModelTestComparison
digitalmodel.orcawave.damping.MultiParameterDampingSweep
The surrounding engineering content — method, conventions, what to
watch for — is unaffected and remains usable.
The intended API is now specified in digitalmodel, at
docs/domains/orcawave/intended-api/damping-sweep.md, where it is a build
target rather than something an agent may mistake for working code.
Tracked in aceengineer-strategy#267, digitalmodel#2045.
Orcawave Damping Sweep
When to Use
- Parametric studies of viscous damping effects
- Roll damping coefficient optimization
- Comparing radiation damping with viscous damping
- Tuning damping to match model test data
- Estimating bilge keel damping contribution
- Critical damping ratio calculations
- Sensitivity analysis for motion predictions
- Roll resonance mitigation studies
Python API
Basic Damping Sweep
from digitalmodel.orcawave.damping import DampingSweep
# Initialize sweep
sweep = DampingSweep()
# Load base model
sweep.load_model("models/fpso.owr")
# Define damping values to sweep
*See sub-skills for full details.*
### Multi-Parameter Sweep
```python
from digitalmodel.orcawave.damping import MultiParameterDampingSweep
# Initialize multi-parameter sweep
sweep = MultiParameterDampingSweep()
# Load model
sweep.load_model("models/fpso.owr")
# Define parameter space
*See sub-skills for full details.*
### Critical Damping Calculation
```python
from digitalmodel.orcawave.damping import CriticalDampingCalculator
# Initialize calculator
calc = CriticalDampingCalculator()
# Load model with mass and stiffness
calc.load_model("models/fpso.owr")
# Calculate critical damping for each DOF
*See sub-skills for full details.*
### Model Test Comparison
```python
from digitalmodel.orcawave.damping import ModelTestComparison
# Initialize comparison
comparison = ModelTestComparison()
# Load OrcaWave results
comparison.load_orcawave_results("results/fpso.owr")
# Load model test data
*See sub-skills for full details.*
### Bilge Keel Estimation
```python
from digitalmodel.orcawave.damping import BilgeKeelDamping
# Initialize bilge keel damping estimator
bk = BilgeKeelDamping()
# Configure vessel parameters
bk.configure_vessel(
beam=50.0, # m
draft=22.0, # m
*See sub-skills for full details.*
### Damping-Period Relationship
```python
from digitalmodel.orcawave.damping import DampingPeriodAnalyzer
# Analyze damping vs period relationship
analyzer = DampingPeriodAnalyzer()
# Load OrcaWave radiation damping results
analyzer.load_results("models/fpso.owr")
# Extract frequency-dependent radiation damping
*See sub-skills for full details.*
## Related Skills
- [orcawave-analysis](../orcawave-analysis/SKILL.md) - OrcaWave diffraction analysis
- [orcawave-to-orcaflex](../orcawave-to-orcaflex/SKILL.md) - Export with damping
- [hydrodynamics](../hydrodynamics/SKILL.md) - Coefficient management
- [viv-analysis](../viv-analysis/SKILL.md) - Vibration damping
## References
- Himeno, Y.: Prediction of Ship Roll Damping - State of the Art
- Ikeda, Y.: Prediction Methods of Roll Damping of Ships
- OrcaWave Roll Damping Documentation
- Script: `scripts/python/digitalmodel/analysis/run_orcawave_damping_sweep.py`
---
**Version History**
- **1.0.0** (2026-01-17): Initial release with damping sweep, model test comparison, and bilge keel estimation
## Sub-Skills
- [Best Practices](best-practices/SKILL.md)
## Sub-Skills
- [Error Handling](error-handling/SKILL.md)
## Sub-Skills
- [Version Metadata](version-metadata/SKILL.md)
- [Total Damping Composition (+1)](total-damping-composition/SKILL.md)
- [Damping Sweep Configuration (+1)](damping-sweep-configuration/SKILL.md)
- [CLI Usage](cli-usage/SKILL.md)
- [Typical Values by Vessel Type (+1)](typical-values-by-vessel-type/SKILL.md)
- [Damping-Related Properties](damping-related-properties/SKILL.md)
## Documentation Reference
OrcaWave topics (`data/llm-wiki/orcawave/`):
- `Theory,Dampinglid.md` -- damping lid method for free-surface suppression
- `Theory,Hydrodynamicdrag.md` -- linearized viscous drag in frequency domain
- `Results,Rolldamping.md` -- roll damping results output
- `Results,Addedmassanddamping.md` -- radiation damping vs frequency
- `Data,Springdampers.md` -- external damping specification
OrcaFlex topics (`data/llm-wiki/orcaflex/`):
- `Vesseltypes,Otherdamping.md` -- additional damping in vessel types
- `Vesseltheory,Otherdamping.md` -- damping theory beyond radiation
Papers (`data/llm-wiki/papers/`):
- `Structural-Damping.md` -- structural damping concepts
- `Spar-Buoy-Equation-of-Motion.md` -- damping in spar buoy dynamics
1---2name: orcawave-damping-sweep-23description: Viscous damping analysis for OrcaWave. Use when running parametric damping sweeps, optimizing roll damping coefficients, computing critical damping, or comparing damping results with model test data for vessel motion tuning.4---56<!-- ace:api-missing-warning -->7> [!WARNING]8> **Part of the Python API documented below does not exist in9> `digitalmodel`.** These snippets are a *specification* of intended10> capability, not runnable code. Do not import them, and do not report11> a result obtained by pretending they ran.12>13> Absent as of this revision:14> - `digitalmodel.orcawave.damping`15> - `digitalmodel.orcawave.damping.BilgeKeelDamping`16> - `digitalmodel.orcawave.damping.CriticalDampingCalculator`17> - `digitalmodel.orcawave.damping.DampingPeriodAnalyzer`18> - `digitalmodel.orcawave.damping.DampingSweep`19> - `digitalmodel.orcawave.damping.ModelTestComparison`20> - `digitalmodel.orcawave.damping.MultiParameterDampingSweep`21>22> The surrounding engineering content — method, conventions, what to23> watch for — is unaffected and remains usable.24>25> **The intended API is now specified in `digitalmodel`**, at26> `docs/domains/orcawave/intended-api/damping-sweep.md`, where it is a build27> target rather than something an agent may mistake for working code.28> Tracked in aceengineer-strategy#267, digitalmodel#2045.2930<!-- ace:known-missing: digitalmodel.orcawave.damping, digitalmodel.orcawave.damping.BilgeKeelDamping, digitalmodel.orcawave.damping.CriticalDampingCalculator, digitalmodel.orcawave.damping.DampingPeriodAnalyzer, digitalmodel.orcawave.damping.DampingSweep, digitalmodel.orcawave.damping.ModelTestComparison, digitalmodel.orcawave.damping.MultiParameterDampingSweep -->3132# Orcawave Damping Sweep3334## When to Use3536- Parametric studies of viscous damping effects37- Roll damping coefficient optimization38- Comparing radiation damping with viscous damping39- Tuning damping to match model test data40- Estimating bilge keel damping contribution41- Critical damping ratio calculations42- Sensitivity analysis for motion predictions43- Roll resonance mitigation studies4445## Python API4647### Basic Damping Sweep4849```python50from digitalmodel.orcawave.damping import DampingSweep5152# Initialize sweep53sweep = DampingSweep()5455# Load base model56sweep.load_model("models/fpso.owr")5758# Define damping values to sweep5960*See sub-skills for full details.*61### Multi-Parameter Sweep6263```python64from digitalmodel.orcawave.damping import MultiParameterDampingSweep6566# Initialize multi-parameter sweep67sweep = MultiParameterDampingSweep()6869# Load model70sweep.load_model("models/fpso.owr")7172# Define parameter space7374*See sub-skills for full details.*75### Critical Damping Calculation7677```python78from digitalmodel.orcawave.damping import CriticalDampingCalculator7980# Initialize calculator81calc = CriticalDampingCalculator()8283# Load model with mass and stiffness84calc.load_model("models/fpso.owr")8586# Calculate critical damping for each DOF8788*See sub-skills for full details.*89### Model Test Comparison9091```python92from digitalmodel.orcawave.damping import ModelTestComparison9394# Initialize comparison95comparison = ModelTestComparison()9697# Load OrcaWave results98comparison.load_orcawave_results("results/fpso.owr")99100# Load model test data101102*See sub-skills for full details.*103### Bilge Keel Estimation104105```python106from digitalmodel.orcawave.damping import BilgeKeelDamping107108# Initialize bilge keel damping estimator109bk = BilgeKeelDamping()110111# Configure vessel parameters112bk.configure_vessel(113 beam=50.0, # m114 draft=22.0, # m115116*See sub-skills for full details.*117### Damping-Period Relationship118119```python120from digitalmodel.orcawave.damping import DampingPeriodAnalyzer121122# Analyze damping vs period relationship123analyzer = DampingPeriodAnalyzer()124125# Load OrcaWave radiation damping results126analyzer.load_results("models/fpso.owr")127128# Extract frequency-dependent radiation damping129130*See sub-skills for full details.*131132## Related Skills133134- [orcawave-analysis](../orcawave-analysis/SKILL.md) - OrcaWave diffraction analysis135- [orcawave-to-orcaflex](../orcawave-to-orcaflex/SKILL.md) - Export with damping136- [hydrodynamics](../hydrodynamics/SKILL.md) - Coefficient management137- [viv-analysis](../viv-analysis/SKILL.md) - Vibration damping138139## References140141- Himeno, Y.: Prediction of Ship Roll Damping - State of the Art142- Ikeda, Y.: Prediction Methods of Roll Damping of Ships143- OrcaWave Roll Damping Documentation144- Script: `scripts/python/digitalmodel/analysis/run_orcawave_damping_sweep.py`145146---147148**Version History**149150- **1.0.0** (2026-01-17): Initial release with damping sweep, model test comparison, and bilge keel estimation151152## Sub-Skills153154- [Best Practices](best-practices/SKILL.md)155156## Sub-Skills157158- [Error Handling](error-handling/SKILL.md)159160## Sub-Skills161162- [Version Metadata](version-metadata/SKILL.md)163- [Total Damping Composition (+1)](total-damping-composition/SKILL.md)164- [Damping Sweep Configuration (+1)](damping-sweep-configuration/SKILL.md)165- [CLI Usage](cli-usage/SKILL.md)166- [Typical Values by Vessel Type (+1)](typical-values-by-vessel-type/SKILL.md)167- [Damping-Related Properties](damping-related-properties/SKILL.md)168169170## Documentation Reference171172OrcaWave topics (`data/llm-wiki/orcawave/`):173- `Theory,Dampinglid.md` -- damping lid method for free-surface suppression174- `Theory,Hydrodynamicdrag.md` -- linearized viscous drag in frequency domain175- `Results,Rolldamping.md` -- roll damping results output176- `Results,Addedmassanddamping.md` -- radiation damping vs frequency177- `Data,Springdampers.md` -- external damping specification178179OrcaFlex topics (`data/llm-wiki/orcaflex/`):180- `Vesseltypes,Otherdamping.md` -- additional damping in vessel types181- `Vesseltheory,Otherdamping.md` -- damping theory beyond radiation182183Papers (`data/llm-wiki/papers/`):184- `Structural-Damping.md` -- structural damping concepts185- `Spar-Buoy-Equation-of-Motion.md` -- damping in spar buoy dynamics