ConditionalModifier.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (C) 2017-2025 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/Tag.h>
#include <Load/Amplitude/Amplitude.h>
#include <Toolbox/ResourceHolder.h>
 
class DomainBase;
 
class ConditionalModifier : public UniqueTag {
protected:
    const bool initialized = false;
 
    const bool connected = false;
 
    unsigned start_step{1u}, end_step{static_cast<unsigned>(-1)};
 
    const unsigned amplitude_tag;
 
    uvec node_encoding; // node/element encoding
    uvec dof_reference; // reference DoF ZERO based
    uvec dof_encoding;  // DoF encoding
 
    ResourceHolder<Amplitude> amplitude;
 
    uvec get_nodal_active_dof(const shared_ptr<DomainBase>&);
    uvec get_all_nodal_active_dof(const shared_ptr<DomainBase>&);
 
public:
    ConditionalModifier(
        unsigned, // tag
        unsigned, // amplitude tag
        uvec&&,   // node tag
        uvec&&    // dof tag
    );
 
    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]] const uvec& get_node_encoding() const;
    [[nodiscard]] const uvec& get_dof_encoding() const;
 
    void set_initialized(bool) const;
    [[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;
 
    void set_connected(bool) const;
    [[nodiscard]] bool is_connected() const;
 
    [[nodiscard]] bool validate_step(const shared_ptr<DomainBase>&) const;
 
    // some may manage state
    virtual void update_status(const vec&);
    virtual void commit_status();
    virtual void clear_status();
    virtual void reset_status();
};
 
#endif