MaterForge - Materials Formulation Engine with Python

A high-performance Python library for material simulation and analysis. MaterForge enables efficient modeling of pure metals and alloys through YAML configuration files, providing symbolic and numerical property evaluation for various material properties.

Contents:

• Getting Started with MaterForge
  • Prerequisites
  • Installation
  • Core Concepts
  • Your First Material
    • 1. Create simple_steel.yaml
    • 2. Load and Evaluate in Python
    • 3. Using a Different Dependency Symbol
  • Validating a YAML File
  • Inspecting a Material Without Creating It
  • Next Steps
• Creating Your First Material Simulation
  • Prerequisites
  • Overview
  • Step 1: Set Up the Simulation Framework
  • Step 2: Create the Material
  • Step 3: Set Up the Heat Equation
  • Step 4: Build the Assignment Collection and Generate Code
  • Step 5: Property Inversion (Optional)
  • Complete Example
  • Next Steps
• Defining Custom Material Properties
  • Overview
  • YAML Configuration Options
    • 1. Constant Value
    • 2. Step Functions
    • 3. Importing from External Files
    • 4. Tabular Data
    • 5. Piecewise Equations
    • 6. Computed Properties
  • Dependency Definition Formats
  • Bounds Options
  • Regression Configuration
  • Complete Example
  • Best Practices
  • Important Notes
• Inverting Material Properties
  • Why Property Inversion Matters
  • Forward Evaluation
  • Inverse: From Property Value Back to Dependency
  • input_symbol and output_symbol are the actual SymPy symbols used in the original expression and its inverse respectively
  • Round-Trip Validation
  • Using a Different Dependency Symbol
  • Known Limitation
  • Best Practices
• Design Philosophy of MaterForge
  • Core Principles
  • Layered Architecture
    • 1. User Interface Layer (YAML Configuration)
    • 2. Parsing Layer (Python)
    • 3. Symbolic Representation Layer (SymPy)
    • 4. Algorithms Layer (Python)
    • 5. Visualization Layer (Python)
    • 6. Core Layer (Python)
  • Modular Architecture
    • Core Module (materforge.core)
    • Parsing Module (materforge.parsing)
    • Algorithms Module (materforge.algorithms)
    • Visualization Module (materforge.visualization)
    • Data Module (materforge.data)
  • Why YAML?
  • Integration with pystencils
  • Property Type System
    • Six Property Types
    • Automatic Type Detection
  • Dependency Resolution
    • Dependency Analysis
    • Processing Order
  • Schema-Agnostic Material Model
  • Error Handling Philosophy
    • Validation at Every Layer
    • Contextual Error Messages
  • Performance Optimization
    • Symbolic Computation
    • Memory Efficiency
  • Testing and Validation
    • Unit Testing
    • Integration Testing
  • Scientific Computing Integration
    • SymPy Integration
    • NumPy Integration
    • Matplotlib Integration
• Defining Custom Material Properties
  • Overview
  • YAML Configuration Options
    • 1. Constant Value
    • 2. Step Functions
    • 3. Importing from External Files
    • 4. Tabular Data
    • 5. Piecewise Equations
    • 6. Computed Properties
  • Dependency Definition Formats
  • Bounds Options
  • Regression Configuration
  • Complete Example
  • Best Practices
• YAML Schema for Material Definition
  • Schema Overview
  • Property Definition Types
    • 1. Constant Value
    • 2. Step Function
    • 3. File Import
    • 4. Tabular Data
    • 5. Piecewise Equation
    • 6. Computed Property
  • Dependency Definition Formats
  • Bounds Options
  • Regression Configuration
  • Visualization
  • Property Inversion
  • Validation Rules
  • Important Notes
• API Reference
  • Core Module
    • Material Class
  • Algorithms Module
  • Parsing Module
  • Visualization Module
• Material API Reference
  • Core Classes
    • Material
  • Main API Functions
    • create_material
    • validate_yaml_file
    • get_material_info
    • get_material_property_names
    • evaluate_material_properties
  • YAML Placeholder Contract
  • Property Type Enum
  • Error Handling

Indices and tables

• Index

• Module Index

• Search Page