Program Listing for File field_function.h

↰ Return to documentation for file (framework/field_functions/field_function.h)

// SPDX-FileCopyrightText: 2024 The OpenSn Authors <https://open-sn.github.io/opensn/>
// SPDX-License-Identifier: MIT

#pragma once

#include "framework/parameters/input_parameters.h"
#include "framework/math/unknown_manager/unknown_manager.h"
#include "framework/mesh/mesh.h"

namespace opensn
{
class Cell;

class FieldFunction
{
public:
  static InputParameters GetInputParameters();
  explicit FieldFunction(const InputParameters& params);

  FieldFunction(std::string name, Unknown unknown);

  virtual ~FieldFunction() = default;

  /// Returns the text name of the field function.
  const std::string& GetName() const { return name_; }

  /// Returns a reference to the unknown structure.
  const Unknown& GetUnknown() const { return unknown_; }

  /// Returns a reference to the unknown manager that can be with spatial discretizations.
  const UnknownManager& GetUnknownManager() const { return unknown_manager_; }

  /// Evaluate the field function on a given cell, at a given position, for the given component.
  virtual double Evaluate(const Cell& cell, const Vector3& position, int component) const
  {
    return 0.0;
  }

protected:
  std::string name_;
  Unknown unknown_;
  UnknownManager unknown_manager_;
};

} // namespace opensn