Class FieldFunction

• Defined in File field_function.h

Inheritance Relationships

Derived Type

• public opensn::FieldFunctionGridBased (Class FieldFunctionGridBased)

Class Documentation

class FieldFunction

Subclassed by opensn::FieldFunctionGridBased

Public Functions

explicit FieldFunction(const InputParameters &params)

FieldFunction(std::string name, Unknown unknown)

virtual ~FieldFunction() = default

inline const std::string &GetName() const

Returns the text name of the field function.

inline const Unknown &GetUnknown() const

Returns a reference to the unknown structure.

inline const UnknownManager &GetUnknownManager() const

Returns a reference to the unknown manager that can be with spatial discretizations.

inline virtual double Evaluate(const Cell &cell, const Vector3 &position, int component) const

Evaluate the field function on a given cell, at a given position, for the given component.

Public Static Functions

static InputParameters GetInputParameters()

Protected Attributes

std::string name_

Unknown unknown_

UnknownManager unknown_manager_