fieldFunction.hpp

#ifndef ABLATELIBRARY_FIELDFUNCTION_HPP
#define ABLATELIBRARY_FIELDFUNCTION_HPP
#include <memory>
#include <string>
#include "domain/region.hpp"
#include "mathFunctions/mathFunction.hpp"
 
namespace ablate::mathFunctions {
class FieldFunction {
   private:
    const std::shared_ptr<mathFunctions::MathFunction> solutionField;
    const std::shared_ptr<mathFunctions::MathFunction> timeDerivative;
    const std::string fieldName;
    const std::shared_ptr<ablate::domain::Region> region;
 
   public:
    /*
     * Public constructor for field functions that has both
     */
    FieldFunction(std::string fieldName, std::shared_ptr<mathFunctions::MathFunction> solutionField, std::shared_ptr<mathFunctions::MathFunction> timeDerivative = {},
                  std::shared_ptr<ablate::domain::Region> region = nullptr);
 
    [[nodiscard]] const std::string& GetName() const { return fieldName; }
 
    [[nodiscard]] bool HasSolutionField() const { return solutionField != nullptr; }
 
    mathFunctions::MathFunction& GetSolutionField() { return *solutionField; }
 
    [[nodiscard]] std::shared_ptr<mathFunctions::MathFunction> GetFieldFunction() const { return solutionField; }
 
    [[nodiscard]] bool HasTimeDerivative() const { return timeDerivative != nullptr; }
 
    mathFunctions::MathFunction& GetTimeDerivative() { return *timeDerivative; }
 
    [[nodiscard]] std::shared_ptr<mathFunctions::MathFunction> GetTimeDerivativeFunction() const { return timeDerivative; }
 
    [[nodiscard]] const std::shared_ptr<ablate::domain::Region>& GetRegion() const { return region; }
};
}  // namespace ablate::mathFunctions
#endif  // ABLATELIBRARY_FIELDFUNCTION_HPP