ConditionalModifier.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (C) 2017-2026 Theodore Chang
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
#ifndef CONDITIONALMODIFIER_H
#define CONDITIONALMODIFIER_H
 
#include <Domain/DomainBase.h>
#include <Domain/Node.h>
#include <Load/Amplitude/Amplitude.h>
#include <Toolbox/ResourceHolder.h>
#include <set>
 
class ConditionalModifier : public UniqueTag {
    const unsigned amplitude_tag;
 
    bool initialized = false;
 
    ResourceHolder<Amplitude> amplitude;
 
    // indicate which DOF components of the target nodes/elements shall be found
    // the modifier itself will apply itself to those active components
    const std::vector<Node::DOF> dof_component;
 
protected:
    unsigned start_step{1u}, end_step{static_cast<unsigned>(-1)};
 
    // indicate the order of DOF components
    // used to validate of the problem is compatible
    // the target nodes must have the exact order of DoFs
    // it can be empty such that the order check is not performed
    const std::vector<Node::DOF> dof_order;
 
    uvec target_node, target_element, target_dof;
 
    [[nodiscard]] double get_amplitude(const shared_ptr<DomainBase>&) const;
 
    [[nodiscard]] const std::vector<Node::DOF>& get_dof_component() const;
 
    [[nodiscard]] bool validate_node(const shared_ptr<DomainBase>&) const;
    [[nodiscard]] bool validate_element(const shared_ptr<DomainBase>&) const;
 
    [[nodiscard]] uvec collect_node_dof(const shared_ptr<DomainBase>&) const;
 
public:
    ConditionalModifier(
        unsigned,                 // tag
        unsigned,                 // amplitude tag
        std::vector<Node::DOF>&&, // dof order
        std::vector<Node::DOF>&&  // dof component (unordered)
    );
 
    virtual int initialize(const shared_ptr<DomainBase>&);
 
    virtual int process(const shared_ptr<DomainBase>&) = 0;
    virtual int process_resistance(const shared_ptr<DomainBase>&);
 
    virtual void stage(const shared_ptr<DomainBase>&) {}
 
    [[nodiscard]] std::set<uword> get_involving_nodes(const shared_ptr<DomainBase>&) const;
 
    [[nodiscard]] const uvec& get_node_dof() const;
 
    void deinitialize();
    [[nodiscard]] bool is_initialized() const;
 
    void set_start_step(unsigned);
    [[nodiscard]] unsigned get_start_step() const;
 
    void set_end_step(unsigned);
    [[nodiscard]] unsigned get_end_step() const;
 
    [[nodiscard]] virtual bool is_connected() const { return false; }
 
    [[nodiscard]] bool validate_step(const shared_ptr<DomainBase>&) const;
 
    // some may manage state
    virtual void update_status(const vec&) {}
    virtual void clear_status() {}
    virtual void commit_status() {}
    virtual void reset_status() {}
};
 
class GroupModifier {
    const uvec groups;
 
protected:
    [[nodiscard]] uvec update_object_tag(const shared_ptr<DomainBase>&) const;
 
public:
    explicit GroupModifier(uvec&&);
};
 
std::vector<Node::DOF> parse_dof(std::string_view);
 
#endif