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

#include <chi_ffinter_line.h>

Inheritance diagram for chi_mesh::FieldFunctionInterpolationLine:
chi_mesh::FieldFunctionInterpolation

Public Member Functions

 FieldFunctionInterpolationLine ()
 
int & GetNumberOfPoints ()
 
chi_mesh::Vector3 & GetInitialPoint ()
 
chi_mesh::Vector3 & GetFinalPoint ()
 
std::vector< std::vector< double > > & GetCustomArrays ()
 
std::vector< chi_mesh::Vector3 > & GetInterpolationPoints ()
 
std::vector< FieldFunctionContext > & GetFFContexts ()
 
void Initialize () override
 
void Execute () override
 
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

int number_of_points_ = 2
 
chi_mesh::Vector3 pi_
 
chi_mesh::Vector3 pf_
 
std::vector< std::vector< double > > custom_arrays_
 
std::vector< chi_mesh::Vector3 > interpolation_points_
 
std::vector< FieldFunctionContext > ff_contexts_
 
double delta_d_ = 1.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 24 of file chi_ffinter_line.h.

Constructor & Destructor Documentation

◆ FieldFunctionInterpolationLine()

chi_mesh::FieldFunctionInterpolationLine::FieldFunctionInterpolationLine ( )
inline

Definition at line 38 of file chi_ffinter_line.h.

Member Function Documentation

◆ Execute()

void chi_mesh::FieldFunctionInterpolationLine::Execute ( )
overridevirtual

Executes the interpolation.

Reimplemented from chi_mesh::FieldFunctionInterpolation.

Definition at line 14 of file chi_ffinter_line_execute.cc.

◆ ExportPython()

void chi_mesh::FieldFunctionInterpolationLine::ExportPython ( std::string  base_name)
overridevirtual

Implements chi_mesh::FieldFunctionInterpolation.

Definition at line 13 of file chi_ffinter_line_exportpython.cc.

◆ GetCustomArrays()

std::vector< std::vector< double > > & chi_mesh::FieldFunctionInterpolationLine::GetCustomArrays ( )
inline

Definition at line 45 of file chi_ffinter_line.h.

◆ GetDefaultFileBaseName()

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

Implements chi_mesh::FieldFunctionInterpolation.

Definition at line 57 of file chi_ffinter_line.h.

◆ GetFFContexts()

std::vector< FieldFunctionContext > & chi_mesh::FieldFunctionInterpolationLine::GetFFContexts ( )
inline

Definition at line 48 of file chi_ffinter_line.h.

◆ GetFinalPoint()

chi_mesh::Vector3 & chi_mesh::FieldFunctionInterpolationLine::GetFinalPoint ( )
inline

Definition at line 44 of file chi_ffinter_line.h.

◆ GetInitialPoint()

chi_mesh::Vector3 & chi_mesh::FieldFunctionInterpolationLine::GetInitialPoint ( )
inline

Definition at line 43 of file chi_ffinter_line.h.

◆ GetInterpolationPoints()

std::vector< chi_mesh::Vector3 > & chi_mesh::FieldFunctionInterpolationLine::GetInterpolationPoints ( )
inline

Definition at line 46 of file chi_ffinter_line.h.

◆ GetNumberOfPoints()

int & chi_mesh::FieldFunctionInterpolationLine::GetNumberOfPoints ( )
inline

Definition at line 42 of file chi_ffinter_line.h.

◆ Initialize()

void chi_mesh::FieldFunctionInterpolationLine::Initialize ( )
overridevirtual

Initializes the data structures necessary for interpolation. This is independent of the physics and hence is a routine on its own.

Reimplemented from chi_mesh::FieldFunctionInterpolation.

Definition at line 15 of file chi_ffinter_line_initialize.cc.

Field Documentation

◆ custom_arrays_

std::vector<std::vector<double> > chi_mesh::FieldFunctionInterpolationLine::custom_arrays_
protected

Definition at line 31 of file chi_ffinter_line.h.

◆ delta_d_

double chi_mesh::FieldFunctionInterpolationLine::delta_d_ = 1.0
protected

Definition at line 35 of file chi_ffinter_line.h.

◆ ff_contexts_

std::vector<FieldFunctionContext> chi_mesh::FieldFunctionInterpolationLine::ff_contexts_
protected

Definition at line 33 of file chi_ffinter_line.h.

◆ interpolation_points_

std::vector<chi_mesh::Vector3> chi_mesh::FieldFunctionInterpolationLine::interpolation_points_
protected

Definition at line 32 of file chi_ffinter_line.h.

◆ number_of_points_

int chi_mesh::FieldFunctionInterpolationLine::number_of_points_ = 2
protected

Definition at line 28 of file chi_ffinter_line.h.

◆ pf_

chi_mesh::Vector3 chi_mesh::FieldFunctionInterpolationLine::pf_
protected

Definition at line 29 of file chi_ffinter_line.h.

◆ pi_

chi_mesh::Vector3 chi_mesh::FieldFunctionInterpolationLine::pi_
protected

Definition at line 29 of file chi_ffinter_line.h.

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