Welcome to MIAM’s documentation!

Model-Independent Aerosol Module — a C++ library for representing aerosol and cloud particle populations and their chemical and physical transformations, designed to plug into the MICM chemistry solver.

MIAM is part of the MUSICA family of atmospheric chemistry tools developed at NSF NCAR.

Getting started

Check out the getting started guide to build and install MIAM.

Installation

User guide

Learn how to build aerosol models and configure MIAM here!

Concepts

API reference

The source code for MIAM is heavily documented. This reference will help you extend MIAM for your needs.

API Reference

Developer guide

If you’d like to contribute new science code or update the docs, check out the developer guide!

Adding a Process

Science guide

Dig into the science behind the processes and representations MIAM implements.

Henry’s Law Phase Transfer

Getting Started

• Installation
  • Requirements
  • Building from Source
  • CMake Options
  • Docker
• Quickstart
  • Complete example
  • What happens
  • Next steps

User Guide

• Concepts
  • Architecture Overview
  • Data Flow
  • Species Naming Convention
• Representations
  • SingleMomentMode
  • TwoMomentMode
  • UniformSection
  • Multi-Phase Modes
  • Species Property Requirements
  • Accessing State Variables
• Processes
  • DissolvedReversibleReaction
  • HenryLawPhaseTransfer
  • Rate Constants
  • Adding Processes to a Model
• Building a Model
  • Basic Setup
  • Multi-Model Systems
  • MICM Integration
  • State Initialization
  • Time Integration
• Aerosol Properties
  • AerosolProperty Enum
  • Provider Pattern
  • How Providers Are Built
  • Derivative Chain
  • Per-Representation Derivatives
• Diagnosing Solver Failures in MIAM
  • Common Causes of Solver Failure
  • Diagnostic Strategies
  • Case Study: Inconsistent Initial Conditions in CAM Cloud Chemistry
  • High-Level Takeaways

Science Guide

• Henry’s Law Phase Transfer
  • Physics
  • Henry’s Law Constant
  • Condensation Rate
  • Evaporation Rate
  • Phase Volume Fraction
  • Solvent Volume Fraction
  • Net Transfer Rate
  • Jacobian
  • Aerosol Property Derivatives
• Dissolved Reversible Reactions
  • Equilibrium Constant
  • Rate Expression
  • Net Rate and Forcing
  • Jacobian
  • No Aerosol Properties Required
  • Multiple Instances
• Size Distributions
  • Log-Normal (Modal)
  • Sectional (UniformSection)
  • Volume Calculations

API Reference

• API Reference
  • Model
  • Processes
  • Representations
  • Utilities

Developer Guide

• Adding a Process
  • Process Interface
  • Registering the New Type
  • Sign Convention Checklist
• Adding a Representation
  • Representation Interface
  • Provider Contract
  • Registering the New Type
  • Testing Providers
• Testing
  • Test Structure
  • Running Tests
  • Unit Tests
  • Integration Tests
  • Test Utilities
  • Adding a New Test

Indices and tables

• Index

• Search Page