BaseSettings

class ansys.health.heart.settings.settings.BaseSettings(/, **data: Any)

Bases: pydantic.BaseModel

Base class for all settings with Pydantic validation and serialization.

Examples

>>> settings = BaseSettings()
>>> settings.to_consistent_unit_system()
>>> data = settings.model_dump_json()

Overview

Methods

serialize_quantities_for_json	Serialize Quantity objects for JSON output.
parse_quantity	Parse string values to Quantity objects for fields annotated as Quantity.
to_consistent_unit_system	Convert units to consistent system [“MPa”, “mm”, “N”, “ms”, “g”].

Attributes

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Special methods

__repr__

Represent object in YAML-style format using Pydantic v2 serialization.

Import detail

from ansys.health.heart.settings.settings import BaseSettings

Attribute detail

BaseSettings.model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Method detail

BaseSettings.__repr__() → str

Represent object in YAML-style format using Pydantic v2 serialization.

Returns:

str

YAML-formatted string representation of the object.

BaseSettings.serialize_quantities_for_json(value: Any, _info) → str | float | Any

Serialize Quantity objects for JSON output.

This serializer handles Quantity objects during JSON serialization, providing string representation. Handles nested Quantity objects in dictionaries and lists.

Parameters:

valueAny

The field value to serialize.

_infoSerializationInfo

Pydantic serialization context (unused but required by signature).

Returns:

str | float | Any

String representation if Quantity, otherwise unchanged.

BaseSettings.parse_quantity(v, info)

Parse string values to Quantity objects for fields annotated as Quantity.

This validator applies to all fields and attempts to parse string values as Quantity objects when the field is annotated with Quantity type. For nested models, it ensures proper Quantity parsing across all levels.

Parameters:

vAny

The value to validate and potentially convert to a Quantity.

infoValidationInfo

Pydantic validation context containing field information.

Returns:

Any

Quantity object if conversion successful, otherwise the original value.

BaseSettings.to_consistent_unit_system() → None

Convert units to consistent system [“MPa”, “mm”, “N”, “ms”, “g”].

This method converts all Quantity objects to use the PyAnsys Heart standard unit system for cardiac simulations.

Examples

>>> from pint import Quantity
>>> settings = BaseSettings()
>>> # Assuming a Quantity field exists
>>> settings.to_consistent_unit_system()