Chi-Tech
Public Member Functions | Protected Attributes
chi_mesh::FieldFunctionInterpolationPoint Class Reference

#include <chi_ffinter_point.h>

Inheritance diagram for chi_mesh::FieldFunctionInterpolationPoint:
chi_mesh::FieldFunctionInterpolation

Public Member Functions

 FieldFunctionInterpolationPoint ()
 
chi_mesh::Vector3 & GetPointOfInterest ()
 
void Initialize () override
 
void Execute () override
 
double GetPointValue () const
 
std::string GetDefaultFileBaseName () const override
 
void ExportPython (std::string base_name) override
 
- Public Member Functions inherited from chi_mesh::FieldFunctionInterpolation
 FieldFunctionInterpolation (ff_interpolation::Type type)
 
std::vector< chi_physics::FieldFunctionGridBasedPtr > & GetFieldFunctions ()
 
ff_interpolation::Type Type () const
 
virtual void Initialize ()
 
virtual void Execute ()
 
virtual std::string GetDefaultFileBaseName () const =0
 
virtual void ExportPython (std::string base_name)=0
 

Protected Attributes

chi_mesh::Vector3 point_of_interest_
 
bool locally_owned_ = false
 
uint64_t owning_cell_gid_ = 0
 
double point_value_ = 0.0
 
- Protected Attributes inherited from chi_mesh::FieldFunctionInterpolation
ff_interpolation::Type type_
 
unsigned int ref_component_ = 0
 
std::vector< chi_physics::FieldFunctionGridBasedPtr > field_functions_
 

Detailed Description

A line based interpolation function.

Definition at line 11 of file chi_ffinter_point.h.

Constructor & Destructor Documentation

◆ FieldFunctionInterpolationPoint()

chi_mesh::FieldFunctionInterpolationPoint::FieldFunctionInterpolationPoint ( )
inline

Definition at line 22 of file chi_ffinter_point.h.

Member Function Documentation

◆ Execute()

void chi_mesh::FieldFunctionInterpolationPoint::Execute ( )
overridevirtual

Executes the point interpolator.

Reimplemented from chi_mesh::FieldFunctionInterpolation.

Definition at line 74 of file chi_ffinter_point.cc.

◆ ExportPython()

void chi_mesh::FieldFunctionInterpolationPoint::ExportPython ( std::string  base_name)
inlineoverridevirtual

Implements chi_mesh::FieldFunctionInterpolation.

Definition at line 35 of file chi_ffinter_point.h.

◆ GetDefaultFileBaseName()

std::string chi_mesh::FieldFunctionInterpolationPoint::GetDefaultFileBaseName ( ) const
inlineoverridevirtual

Implements chi_mesh::FieldFunctionInterpolation.

Definition at line 33 of file chi_ffinter_point.h.

◆ GetPointOfInterest()

chi_mesh::Vector3 & chi_mesh::FieldFunctionInterpolationPoint::GetPointOfInterest ( )
inline

Definition at line 26 of file chi_ffinter_point.h.

◆ GetPointValue()

double chi_mesh::FieldFunctionInterpolationPoint::GetPointValue ( ) const

Gets the value of the field function evaluation at the point.

Definition at line 110 of file chi_ffinter_point.cc.

◆ Initialize()

void chi_mesh::FieldFunctionInterpolationPoint::Initialize ( )
overridevirtual

Initializes the point interpolator.

Reimplemented from chi_mesh::FieldFunctionInterpolation.

Definition at line 12 of file chi_ffinter_point.cc.

Field Documentation

◆ locally_owned_

bool chi_mesh::FieldFunctionInterpolationPoint::locally_owned_ = false
protected

Definition at line 17 of file chi_ffinter_point.h.

◆ owning_cell_gid_

uint64_t chi_mesh::FieldFunctionInterpolationPoint::owning_cell_gid_ = 0
protected

Definition at line 18 of file chi_ffinter_point.h.

◆ point_of_interest_

chi_mesh::Vector3 chi_mesh::FieldFunctionInterpolationPoint::point_of_interest_
protected

Definition at line 15 of file chi_ffinter_point.h.

◆ point_value_

double chi_mesh::FieldFunctionInterpolationPoint::point_value_ = 0.0
protected

Definition at line 19 of file chi_ffinter_point.h.

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