Miscibility.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2023 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/physical/common/Class.h"
#include "bio/physical/common/Filters.h"
#include "bio/physical/macro/Macros.h"
#include "bio/physical/common/Superpositions.h"
#include "bio/physical/relativity/Identifiable.h"
#include "bio/physical/wave/Interference.h"
#include "bio/physical/wave/Wave.h"
#include "bio/chemical/Substance.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace chemical {
 
class Miscibility :
    public physical::Class< Miscibility >,
    public physical::Identifiable< Property >
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(physical, Miscibility)
 
    
    Miscibility();
 
    Miscibility(const Property& property);
 
    Miscibility(const Name& name);
 
    virtual ~Miscibility();
 
    static void RegisterDefaults();
 
    void SetSuperposition(const Superposition& superposition);
 
    const Superposition& GetSuperposition() const;
 
    void SetPassthrough(bool passthrough);
 
    bool IsPassthrough() const;
 
    virtual Pointer< const Wave > GetDisplacement(Pointer< const Substance > substance) const;
 
    virtual Pointer< physical::Interference > GetInterference() const;
 
    virtual Pointer< physical::Interference > GetInterferenceFor(
        Pointer< const physical::Wave > target,
        Pointer< const physical::Wave > displacement) const;
 
    void SetInterference(Pointer< physical::Interference > interference);
 
    virtual bool Apply(Pointer< Substance > target, Pointer< const Substance > other) const;
 
protected:
    Pointer< physical::Interference > mInterference;
    Superposition mSuperposition;
    bool mIsPassthrough;
};
 
} //chemical namespace
} //bio namespace
 
#include "bio/chemical/mixture/Miscibilities.h"