ifc_structural/

authoring.rs

//! Selected schema-resolved structural authoring.

use std::collections::HashSet;
use std::sync::Arc;

use ifc_model::guid::Guid;
use ifc_model::{Edit, Entity, EntityId, Model, Transaction, Value};
use ifc_schema::Schema;

use crate::error::{StructuralError, StructuralResult};
use crate::AnalysisModelType;

mod action;
mod condition;
mod item;
mod load_group;
mod reaction;
mod relation;

pub use action::{stage_action, ActionDraft, ActionDraftKind, ProjectedOrTrue};
pub use condition::{
    stage_boundary_condition, stage_connection_condition, BoundaryConditionDraft,
    ConnectionConditionDraft,
};
pub use item::{
    stage_connection, stage_member, ConnectionDraft, ConnectionDraftKind, MemberDraft,
    MemberDraftKind, MemberPredefinedType, StructuralRootDraft,
};
pub use load_group::{stage_load_group, LoadGroupDraft, LoadGroupKind};
pub use reaction::{
    stage_reaction, stage_result_group, ReactionDraft, ReactionDraftKind, ResultGroupDraft,
};
pub use relation::{
    stage_activity_assignment, stage_member_connection, ActivityAssignmentDraft,
    MemberConnectionDraft, RelationshipRootDraft,
};

/// Staged fields for creating an `IfcStructuralAnalysisModel` via [`stage_analysis_model`].
#[derive(Debug, Clone)]
pub struct AnalysisModelDraft {
    /// `GlobalId`; must parse as a 22-character IFC GUID.
    pub global_id: String,
    /// `OwnerHistory`, validated against the model/transaction if present.
    pub owner_history: Option<EntityId>,
    /// `Name`.
    pub name: Option<String>,
    /// `Description`.
    pub description: Option<String>,
    /// `ObjectType`; required non-blank when `predefined_type` is `UserDefined`.
    pub object_type: Option<String>,
    /// `PredefinedType`.
    pub predefined_type: AnalysisModelType,
    /// `OrientationOf2DPlane`, an `IfcAxis2Placement3D` reference.
    pub orientation_of_2d_plane: Option<EntityId>,
    /// `LoadedBy`, `IfcStructuralLoadGroup` references; members must be unique.
    pub loaded_by: Vec<EntityId>,
    /// `HasResults`, `IfcStructuralResultGroup` references; members must be unique.
    pub result_groups: Vec<EntityId>,
    /// `SharedPlacement`; only staged when the target schema declares the attribute.
    pub shared_placement: Option<EntityId>,
}

impl Default for AnalysisModelDraft {
    fn default() -> Self {
        Self {
            global_id: "0000000000000000000000".to_owned(),
            owner_history: None,
            name: None,
            description: None,
            object_type: None,
            predefined_type: AnalysisModelType::NotDefined,
            orientation_of_2d_plane: None,
            loaded_by: Vec::new(),
            result_groups: Vec::new(),
            shared_placement: None,
        }
    }
}

/// Staged fields for creating one core `IfcStructuralLoadStatic` subtype via [`stage_load`].
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum LoadDraft {
    /// Stages an `IfcStructuralLoadSingleForce`.
    SingleForce {
        /// `Name`.
        name: Option<String>,
        /// `ForceX`/`ForceY`/`ForceZ`.
        force: [Option<f64>; 3],
        /// `MomentX`/`MomentY`/`MomentZ`.
        moment: [Option<f64>; 3],
    },
    /// Stages an `IfcStructuralLoadLinearForce`.
    LinearForce {
        /// `Name`.
        name: Option<String>,
        /// `LinearForceX`/`LinearForceY`/`LinearForceZ`.
        force: [Option<f64>; 3],
        /// `LinearMomentX`/`LinearMomentY`/`LinearMomentZ`.
        moment: [Option<f64>; 3],
    },
    /// Stages an `IfcStructuralLoadPlanarForce`.
    PlanarForce {
        /// `Name`.
        name: Option<String>,
        /// `PlanarForceX`/`PlanarForceY`/`PlanarForceZ`.
        force: [Option<f64>; 3],
    },
    /// Stages an `IfcStructuralLoadTemperature`.
    Temperature {
        /// `Name`.
        name: Option<String>,
        /// Constant, through-Y and through-Z temperature deltas (`DeltaTConstant`/`DeltaTY`/`DeltaTZ`,
        /// or the underscored equivalents in schemas that name them that way).
        delta: [Option<f64>; 3],
    },
    /// Stages an `IfcStructuralLoadSingleForceWarping`.
    ///
    /// Extends the single force with the bimoment that restrained
    /// warping produces in an open thin-walled section.
    SingleForceWarping {
        /// `Name`.
        name: Option<String>,
        /// `ForceX`/`ForceY`/`ForceZ`.
        force: [Option<f64>; 3],
        /// `MomentX`/`MomentY`/`MomentZ`.
        moment: [Option<f64>; 3],
        /// `WarpingMoment`.
        warping_moment: Option<f64>,
    },
    /// Stages an `IfcStructuralLoadSingleDisplacement`.
    ///
    /// A prescribed movement of a point: three translations and three
    /// rotations. The distortion form below extends this with a
    /// seventh slot; this supertype stops at six.
    SingleDisplacement {
        /// `Name`.
        name: Option<String>,
        /// `DisplacementX`/`DisplacementY`/`DisplacementZ`.
        displacement: [Option<f64>; 3],
        /// `RotationalDisplacementRX`/`RY`/`RZ`.
        rotation: [Option<f64>; 3],
    },
    /// Stages an `IfcStructuralLoadSingleDisplacementDistortion`.
    ///
    /// The displacement counterpart of the warping force: a prescribed
    /// movement rather than an applied load.
    SingleDisplacementDistortion {
        /// `Name`.
        name: Option<String>,
        /// `DisplacementX`/`DisplacementY`/`DisplacementZ`.
        displacement: [Option<f64>; 3],
        /// `RotationalDisplacementRX`/`RY`/`RZ`.
        rotation: [Option<f64>; 3],
        /// `Distortion`.
        distortion: Option<f64>,
    },
    /// Stages an `IfcSurfaceReinforcementArea`.
    ///
    /// Areas are measures, not coordinates: the schema requires each
    /// to be non-negative, and requires at least one of the three to
    /// be present so the record says something.
    SurfaceReinforcementArea {
        /// `Name`.
        name: Option<String>,
        /// `SurfaceReinforcement1`, two or three entries.
        surface_1: Option<Vec<f64>>,
        /// `SurfaceReinforcement2`, two or three entries.
        surface_2: Option<Vec<f64>>,
        /// `ShearReinforcement`.
        shear: Option<f64>,
    },
    /// Stages an `IfcStructuralLoadConfiguration`.
    ///
    /// A list of loads with optional sample locations. When locations
    /// are given the schema requires one per value, so the pairing is
    /// checked here rather than left to a downstream reader.
    Configuration {
        /// `Name`.
        name: Option<String>,
        /// `Values`: the loads sampled, at least one.
        values: Vec<EntityId>,
        /// `Locations`: one coordinate pair per value, or none.
        locations: Option<Vec<[f64; 2]>>,
    },
}

/// Stage an `IfcStructuralAnalysisModel` create edit on `tx`.
///
/// Fails with [`StructuralError::InvalidGlobalId`] if `draft.global_id` is not
/// a valid GUID, [`StructuralError::SemanticViolation`] if `predefined_type`
/// is `UserDefined` without a non-blank `object_type`, and with reference
/// validation errors ([`StructuralError::DanglingReference`],
/// [`StructuralError::WrongReferenceType`], [`StructuralError::InvalidDraftValue`])
/// if any referenced entity is missing, of the wrong type, or a SET contains
/// duplicates. Returns the id staged for the new entity.
pub fn stage_analysis_model(
    tx: &mut Transaction,
    model: &Model,
    schema: &Schema,
    draft: AnalysisModelDraft,
) -> StructuralResult<EntityId> {
    if Guid::parse(&draft.global_id).is_none() {
        return Err(StructuralError::InvalidGlobalId);
    }
    if draft.predefined_type == AnalysisModelType::UserDefined
        && draft
            .object_type
            .as_deref()
            .is_none_or(|value| value.trim().is_empty())
    {
        return Err(StructuralError::SemanticViolation {
            entity: None,
            rule: "USERDEFINED analysis model requires ObjectType",
        });
    }

    validate_unique_set_members(&draft.loaded_by, "IfcStructuralAnalysisModel", "LoadedBy")?;
    validate_unique_set_members(
        &draft.result_groups,
        "IfcStructuralAnalysisModel",
        "HasResults",
    )?;
    validate_optional_ref(tx, model, schema, draft.owner_history, "IfcOwnerHistory")?;
    validate_optional_ref(
        tx,
        model,
        schema,
        draft.orientation_of_2d_plane,
        "IfcAxis2Placement3D",
    )?;
    validate_refs(
        tx,
        model,
        schema,
        &draft.loaded_by,
        "IfcStructuralLoadGroup",
    )?;
    validate_refs(
        tx,
        model,
        schema,
        &draft.result_groups,
        "IfcStructuralResultGroup",
    )?;
    validate_optional_ref(
        tx,
        model,
        schema,
        draft.shared_placement,
        "IfcObjectPlacement",
    )?;

    let mut fields = vec![
        ("GlobalId", Value::Text(Arc::from(draft.global_id))),
        ("Name", optional_text(draft.name)),
        ("Description", optional_text(draft.description)),
        ("ObjectType", optional_text(draft.object_type)),
        (
            "PredefinedType",
            Value::Enum(Arc::from(draft.predefined_type.token())),
        ),
        (
            "OrientationOf2DPlane",
            optional_ref(draft.orientation_of_2d_plane),
        ),
        ("LoadedBy", optional_refs(draft.loaded_by)),
        ("HasResults", optional_refs(draft.result_groups)),
    ];
    if let Some(owner_history) = draft.owner_history {
        fields.push(("OwnerHistory", Value::Ref(owner_history)));
    }
    if schema
        .attribute_names("IfcStructuralAnalysisModel")
        .iter()
        .any(|name| name.eq_ignore_ascii_case("SharedPlacement"))
    {
        fields.push(("SharedPlacement", optional_ref(draft.shared_placement)));
    } else if draft.shared_placement.is_some() {
        return Err(StructuralError::UnsupportedAttribute {
            entity_type: "IfcStructuralAnalysisModel".to_owned(),
            attribute: "SharedPlacement".to_owned(),
        });
    }

    let entity = build_named(schema, "IfcStructuralAnalysisModel", fields)?;
    Ok(tx.create(entity))
}

/// Stage one core `IfcStructuralLoadStatic` subtype create edit on `tx`.
///
/// Fails with [`StructuralError::InvalidDraftValue`] if any numeric component
/// is set to a non-finite value. Returns the id staged for the new entity.
pub fn stage_load(
    tx: &mut Transaction,
    schema: &Schema,
    draft: LoadDraft,
) -> StructuralResult<EntityId> {
    // Two subtypes carry list-valued attributes and WHERE rules of
    // their own, so they cannot ride the shared scalar path below.

    let (entity_type, name, attributes, values): (&str, Option<String>, &[&str], Vec<Option<f64>>) =
        match draft {
            LoadDraft::SurfaceReinforcementArea {
                name,
                surface_1,
                surface_2,
                shear,
            } => return stage_surface_reinforcement(tx, schema, name, surface_1, surface_2, shear),
            LoadDraft::Configuration {
                name,
                values,
                locations,
            } => return stage_load_configuration(tx, schema, name, values, locations),
            LoadDraft::SingleForce {
                name,
                force,
                moment,
            } => (
                "IfcStructuralLoadSingleForce",
                name,
                &[
                    "ForceX", "ForceY", "ForceZ", "MomentX", "MomentY", "MomentZ",
                ],
                force.into_iter().chain(moment).collect(),
            ),
            LoadDraft::LinearForce {
                name,
                force,
                moment,
            } => (
                "IfcStructuralLoadLinearForce",
                name,
                &[
                    "LinearForceX",
                    "LinearForceY",
                    "LinearForceZ",
                    "LinearMomentX",
                    "LinearMomentY",
                    "LinearMomentZ",
                ],
                force.into_iter().chain(moment).collect(),
            ),
            LoadDraft::PlanarForce { name, force } => (
                "IfcStructuralLoadPlanarForce",
                name,
                &["PlanarForceX", "PlanarForceY", "PlanarForceZ"],
                force.to_vec(),
            ),
            LoadDraft::Temperature { name, delta } => {
                let attributes: &[&str] = if schema
                    .attribute_names("IfcStructuralLoadTemperature")
                    .iter()
                    .any(|attribute| attribute.eq_ignore_ascii_case("DeltaTConstant"))
                {
                    &["DeltaTConstant", "DeltaTY", "DeltaTZ"]
                } else {
                    &["DeltaT_Constant", "DeltaT_Y", "DeltaT_Z"]
                };
                (
                    "IfcStructuralLoadTemperature",
                    name,
                    attributes,
                    delta.to_vec(),
                )
            }
            LoadDraft::SingleForceWarping {
                name,
                force,
                moment,
                warping_moment,
            } => (
                "IfcStructuralLoadSingleForceWarping",
                name,
                &[
                    "ForceX",
                    "ForceY",
                    "ForceZ",
                    "MomentX",
                    "MomentY",
                    "MomentZ",
                    "WarpingMoment",
                ],
                force
                    .into_iter()
                    .chain(moment)
                    .chain([warping_moment])
                    .collect(),
            ),
            LoadDraft::SingleDisplacement {
                name,
                displacement,
                rotation,
            } => (
                "IfcStructuralLoadSingleDisplacement",
                name,
                &[
                    "DisplacementX",
                    "DisplacementY",
                    "DisplacementZ",
                    "RotationalDisplacementRX",
                    "RotationalDisplacementRY",
                    "RotationalDisplacementRZ",
                ],
                displacement.into_iter().chain(rotation).collect(),
            ),
            LoadDraft::SingleDisplacementDistortion {
                name,
                displacement,
                rotation,
                distortion,
            } => (
                "IfcStructuralLoadSingleDisplacementDistortion",
                name,
                &[
                    "DisplacementX",
                    "DisplacementY",
                    "DisplacementZ",
                    "RotationalDisplacementRX",
                    "RotationalDisplacementRY",
                    "RotationalDisplacementRZ",
                    "Distortion",
                ],
                displacement
                    .into_iter()
                    .chain(rotation)
                    .chain([distortion])
                    .collect(),
            ),
        };
    for (attribute, value) in attributes.iter().zip(&values) {
        if value.is_some_and(|number| !number.is_finite()) {
            return Err(StructuralError::InvalidDraftValue {
                entity_type,
                attribute,
                expected: "finite load value or null",
            });
        }
    }
    let mut fields = vec![("Name", optional_text(name))];
    fields.extend(
        attributes
            .iter()
            .zip(values)
            .map(|(name, value)| (*name, value.map_or(Value::Null, Value::Real))),
    );
    Ok(tx.create(build_named(schema, entity_type, fields)?))
}

/// Stage an `IfcSurfaceReinforcementArea`, enforcing its four WHERE rules.
///
/// `NonnegativeArea1..3` reject a negative area; `SurfaceAndOrShearArea`
/// rejects a record that specifies nothing at all.
fn stage_surface_reinforcement(
    tx: &mut Transaction,
    schema: &Schema,
    name: Option<String>,
    surface_1: Option<Vec<f64>>,
    surface_2: Option<Vec<f64>>,
    shear: Option<f64>,
) -> StructuralResult<EntityId> {
    const ENTITY: &str = "IfcSurfaceReinforcementArea";

    if surface_1.is_none() && surface_2.is_none() && shear.is_none() {
        return Err(StructuralError::InvalidDraftValue {
            entity_type: ENTITY,
            attribute: "SurfaceReinforcement1",
            expected: "at least one reinforcement area to be specified",
        });
    }

    for (attribute, area) in [
        ("SurfaceReinforcement1", surface_1.as_ref()),
        ("SurfaceReinforcement2", surface_2.as_ref()),
    ] {
        let Some(area) = area else { continue };
        if !(2..=3).contains(&area.len()) {
            return Err(StructuralError::InvalidDraftValue {
                entity_type: ENTITY,
                attribute,
                expected: "two or three area values",
            });
        }
        if area.iter().any(|value| !value.is_finite() || *value < 0.0) {
            return Err(StructuralError::InvalidDraftValue {
                entity_type: ENTITY,
                attribute,
                expected: "finite non-negative area values",
            });
        }
    }

    if shear.is_some_and(|value| !value.is_finite() || value < 0.0) {
        return Err(StructuralError::InvalidDraftValue {
            entity_type: ENTITY,
            attribute: "ShearReinforcement",
            expected: "a finite non-negative area",
        });
    }

    let reals = |values: Option<Vec<f64>>| {
        values.map_or(Value::Null, |values| {
            Value::List(values.into_iter().map(Value::Real).collect())
        })
    };
    let fields = vec![
        ("Name", optional_text(name)),
        ("SurfaceReinforcement1", reals(surface_1)),
        ("SurfaceReinforcement2", reals(surface_2)),
        ("ShearReinforcement", shear.map_or(Value::Null, Value::Real)),
    ];
    Ok(tx.create(build_named(schema, ENTITY, fields)?))
}

/// Stage an `IfcStructuralLoadConfiguration`, enforcing `ValidListSize`.
///
/// Locations are optional, but when present the schema requires exactly
/// one per value: a mismatched pair silently misattributes every sample
/// after the first gap, so it is refused here.
fn stage_load_configuration(
    tx: &mut Transaction,
    schema: &Schema,
    name: Option<String>,
    values: Vec<EntityId>,
    locations: Option<Vec<[f64; 2]>>,
) -> StructuralResult<EntityId> {
    const ENTITY: &str = "IfcStructuralLoadConfiguration";

    if values.is_empty() {
        return Err(StructuralError::InvalidDraftValue {
            entity_type: ENTITY,
            attribute: "Values",
            expected: "at least one load",
        });
    }
    if let Some(locations) = locations.as_ref() {
        if locations.len() != values.len() {
            return Err(StructuralError::InvalidDraftValue {
                entity_type: ENTITY,
                attribute: "Locations",
                expected: "one location per value",
            });
        }
        if locations
            .iter()
            .any(|pair| pair.iter().any(|value| !value.is_finite()))
        {
            return Err(StructuralError::InvalidDraftValue {
                entity_type: ENTITY,
                attribute: "Locations",
                expected: "finite coordinates",
            });
        }
    }

    let fields = vec![
        ("Name", optional_text(name)),
        (
            "Values",
            Value::List(values.into_iter().map(Value::Ref).collect()),
        ),
        (
            "Locations",
            locations.map_or(Value::Null, |locations| {
                Value::List(
                    locations
                        .into_iter()
                        .map(|pair| Value::List(pair.into_iter().map(Value::Real).collect()))
                        .collect(),
                )
            }),
        ),
    ];
    Ok(tx.create(build_named(schema, ENTITY, fields)?))
}

pub(super) fn build_named(
    schema: &Schema,
    entity_type: &str,
    fields: Vec<(&str, Value)>,
) -> StructuralResult<Entity> {
    let attributes = schema.attributes(entity_type);
    if attributes.is_empty() {
        return Err(StructuralError::UnsupportedSchema {
            token: schema.name().to_owned(),
        });
    }
    let mut values = vec![Value::Null; attributes.len()];
    for (name, value) in fields {
        let slot = attributes
            .iter()
            .position(|attribute| attribute.name.eq_ignore_ascii_case(name))
            .ok_or_else(|| StructuralError::UnsupportedAttribute {
                entity_type: entity_type.to_owned(),
                attribute: name.to_owned(),
            })?;
        values[slot] = value;
    }
    for (attribute, value) in attributes.iter().zip(&values) {
        if !attribute.optional && matches!(value, Value::Null) {
            return Err(StructuralError::MissingRequired {
                entity_type: entity_type.to_owned(),
                attribute: attribute.name.clone(),
            });
        }
    }
    Ok(Entity::new(entity_type.to_ascii_uppercase(), values))
}

pub(super) fn optional_text(value: Option<String>) -> Value {
    value.map_or(Value::Null, |value| Value::Text(Arc::from(value)))
}

pub(super) fn optional_ref(value: Option<EntityId>) -> Value {
    value.map_or(Value::Null, Value::Ref)
}

fn optional_refs(values: Vec<EntityId>) -> Value {
    if values.is_empty() {
        Value::Null
    } else {
        Value::List(values.into_iter().map(Value::Ref).collect())
    }
}

pub(super) fn validate_optional_ref(
    tx: &Transaction,
    model: &Model,
    schema: &Schema,
    target: Option<EntityId>,
    expected: &'static str,
) -> StructuralResult<()> {
    if let Some(target) = target {
        validate_ref(tx, model, schema, target, expected)?;
    }
    Ok(())
}

fn validate_refs(
    tx: &Transaction,
    model: &Model,
    schema: &Schema,
    targets: &[EntityId],
    expected: &'static str,
) -> StructuralResult<()> {
    for target in targets {
        validate_ref(tx, model, schema, *target, expected)?;
    }
    Ok(())
}

fn validate_unique_set_members(
    targets: &[EntityId],
    entity_type: &'static str,
    attribute: &'static str,
) -> StructuralResult<()> {
    let mut unique = HashSet::with_capacity(targets.len());
    if targets.iter().all(|target| unique.insert(*target)) {
        return Ok(());
    }
    Err(StructuralError::InvalidDraftValue {
        entity_type,
        attribute,
        expected: "SET of unique entity references",
    })
}

pub(super) fn validate_ref(
    tx: &Transaction,
    model: &Model,
    schema: &Schema,
    target: EntityId,
    expected: &'static str,
) -> StructuralResult<()> {
    validate_ref_select(tx, model, schema, target, expected, &[expected])
}

pub(super) fn validate_ref_select(
    tx: &Transaction,
    model: &Model,
    schema: &Schema,
    target: EntityId,
    expected: &'static str,
    members: &[&str],
) -> StructuralResult<()> {
    let entity = projected_entity(tx, model, target).ok_or(StructuralError::DanglingReference {
        entity: EntityId(0),
        attribute: "draft reference",
        target,
    })?;
    if !members
        .iter()
        .any(|member| schema.is_a(&entity.type_name, member))
    {
        return Err(StructuralError::WrongReferenceType {
            entity: EntityId(0),
            attribute: "draft reference",
            target,
            expected,
            actual: entity.type_name.to_string(),
        });
    }
    Ok(())
}

pub(super) fn projected_entity(
    tx: &Transaction,
    model: &Model,
    target: EntityId,
) -> Option<Entity> {
    let mut projected = model.get(target).cloned();
    for edit in tx.edits() {
        match edit {
            Edit::Create { id, entity } if *id == target => projected = Some(entity.clone()),
            Edit::SetAttribute { id, slot, value } if *id == target => {
                let entity = projected.as_mut()?;
                let attribute = entity.attributes.get_mut(*slot)?;
                *attribute = value.clone();
            }
            Edit::Retype { id, type_name } if *id == target => {
                projected.as_mut()?.type_name = type_name.clone();
            }
            Edit::Remove { id } if *id == target => projected = None,
            _ => {}
        }
    }
    projected
}