Chi-Tech
Public Member Functions | Static Public Member Functions | Private Attributes
chi_physics::FieldFunction Class Reference

#include <fieldfunction.h>

Inheritance diagram for chi_physics::FieldFunction:
ChiObject chi_physics::FieldFunctionGridBased

Public Member Functions

 FieldFunction (const chi::InputParameters &params)
 
 FieldFunction (const std::string &text_name, chi_math::Unknown unknown)
 
virtual ~FieldFunction ()=default
 
const std::string & TextName () const
 
const chi_math::Unknown & Unknown () const
 
const chi_math::UnknownManager & GetUnknownManager () const
 
void PushOntoStack (std::shared_ptr< ChiObject > &new_object) override
 Overrides the stack placement so that FieldFunctions go to the field function stack. More...
 
virtual double Evaluate (const chi_mesh::Cell &cell, const chi_mesh::Vector3 &position, unsigned int component) const
 
- Public Member Functions inherited from ChiObject
 ChiObject ()
 
 ChiObject (const chi::InputParameters &params)
 
void SetStackID (size_t stack_id)
 
size_t StackID () const
 
virtual void PushOntoStack (std::shared_ptr< ChiObject > &new_object)
 
virtual ~ChiObject ()=default
 

Static Public Member Functions

static chi::InputParameters GetInputParameters ()
 
- Static Public Member Functions inherited from ChiObject
static chi::InputParameters GetInputParameters ()
 

Private Attributes

std::string text_name_
 
chi_math::Unknown unknown_
 
chi_math::UnknownManager unknown_manager_
 

Detailed Description

Definition at line 16 of file fieldfunction.h.

Constructor & Destructor Documentation

◆ FieldFunction() [1/2]

chi_physics::FieldFunction::FieldFunction ( const chi::InputParameters &  params)
explicit

ObjectMaker based constructor.

Definition at line 42 of file fieldfunction.cc.

◆ FieldFunction() [2/2]

chi_physics::FieldFunction::FieldFunction ( const std::string &  text_name,
chi_math::Unknown  unknown 
)

Conventional constructor.

Definition at line 62 of file fieldfunction.cc.

◆ ~FieldFunction()

virtual chi_physics::FieldFunction::~FieldFunction ( )
virtualdefault

Member Function Documentation

◆ Evaluate()

virtual double chi_physics::FieldFunction::Evaluate ( const chi_mesh::Cell &  cell,
const chi_mesh::Vector3 &  position,
unsigned int  component 
) const
inlinevirtual

Reimplemented in chi_physics::FieldFunctionGridBased.

Definition at line 51 of file fieldfunction.h.

◆ GetInputParameters()

chi::InputParameters chi_physics::FieldFunction::GetInputParameters ( )
static

Returns required input parameters.

Definition at line 10 of file fieldfunction.cc.

◆ GetUnknownManager()

const chi_math::UnknownManager & chi_physics::FieldFunction::GetUnknownManager ( ) const
inline

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

Definition at line 42 of file fieldfunction.h.

◆ PushOntoStack()

void chi_physics::FieldFunction::PushOntoStack ( std::shared_ptr< ChiObject > &  new_object)
overridevirtual

Overrides the stack placement so that FieldFunctions go to the field function stack.

Stack change to `chi::field_function_stack.

Reimplemented from ChiObject.

Definition at line 72 of file fieldfunction.cc.

◆ TextName()

const std::string & chi_physics::FieldFunction::TextName ( ) const
inline

Returns the text name of the field function.

Definition at line 37 of file fieldfunction.h.

◆ Unknown()

const chi_math::Unknown & chi_physics::FieldFunction::Unknown ( ) const
inline

Returns a reference to the unknown structure.

Definition at line 39 of file fieldfunction.h.

Field Documentation

◆ text_name_

std::string chi_physics::FieldFunction::text_name_
private

Definition at line 19 of file fieldfunction.h.

◆ unknown_

chi_math::Unknown chi_physics::FieldFunction::unknown_
private

Definition at line 20 of file fieldfunction.h.

◆ unknown_manager_

chi_math::UnknownManager chi_physics::FieldFunction::unknown_manager_
private

Definition at line 21 of file fieldfunction.h.

The documentation for this class was generated from the following files: