MassSpringModel.h

// This file is a part of the OpenSurgSim project.
// Copyright 2020, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_PHYSICS_MASSSPRINGMODEL_H
#define SURGSIM_PHYSICS_MASSSPRINGMODEL_H

#include <vector>

#include "SurgSim/DataStructures/OptionalValue.h"
#include "SurgSim/DataStructures/Vertices.h"
#include "SurgSim/Framework/Asset.h"
#include "SurgSim/Math/OdeState.h"
#include "SurgSim/Physics/Mass.h"

namespace SurgSim
{
namespace Physics
{

class Spring;

SURGSIM_STATIC_REGISTRATION(MassSpringModel);

class MassSpringModel : public SurgSim::DataStructures::Vertices<Mass>, public SurgSim::Framework::Asset,
    public std::enable_shared_from_this<MassSpringModel>
{
public:
    MassSpringModel();

    SURGSIM_CLASSNAME(SurgSim::Physics::MassSpringModel);

    void addMass(const std::shared_ptr<Mass> mass);

    void addSpring(const std::shared_ptr<Spring> spring);

    size_t getNumMasses() const;

    size_t getNumSprings() const;

    const std::vector<std::shared_ptr<Mass>>& getMasses() const;

    const std::vector<std::shared_ptr<Spring>>& getSprings() const;

    const std::shared_ptr<Mass>& getMass(size_t nodeId) const;

    const std::shared_ptr<Spring>& getSpring(size_t springId) const;

    size_t addBoundaryCondition(size_t boundaryCondition);

    const std::vector<size_t>& getBoundaryConditions() const;

    std::vector<size_t>& getBoundaryConditions();

    size_t getBoundaryCondition(size_t id) const;

    size_t addElement(const std::vector<size_t>& nodeIds);

    const std::vector<size_t>& getNodeIds(size_t index) const;

    size_t getNumElements() const;

    size_t getNumNodesPerElement() const;

    void setRadius(double radius);
    const DataStructures::OptionalValue<double>& getRadius() const;

    void setThickness(double thickness);
    const DataStructures::OptionalValue<double>& getThickness() const;

    bool save(const std::string& fileName, double physicsLength = 0.0) const;

protected:
    bool doLoad(const std::string& filePath) override;

    std::vector<std::shared_ptr<Mass>> m_masses;

    std::vector<std::shared_ptr<Spring>> m_springs;

    std::vector<size_t> m_boundaryConditions;

    std::vector<std::vector<size_t>> m_nodeIds;

    DataStructures::OptionalValue<double> m_radius;

    DataStructures::OptionalValue<double> m_thickness;
};

} // namespace Physics
} // namespace SurgSim

#endif // SURGSIM_PHYSICS_MASSSPRINGMODEL_H