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

#include <chi_ffinter_volume.h>

Inheritance diagram for chi_mesh::FieldFunctionInterpolationVolume:
chi_mesh::FieldFunctionInterpolation

Public Member Functions

 FieldFunctionInterpolationVolume ()
 
std::shared_ptr< chi_mesh::LogicalVolume > & GetLogicalVolume ()
 
ff_interpolation::Operation & GetOperationType ()
 
std::string & GetOperationLuaFunction ()
 
double & GetOpValue ()
 
void Initialize () override
 
void Execute () override
 
double CallLuaFunction (double ff_value, int mat_id) 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

std::shared_ptr< chi_mesh::LogicalVolume > logical_volume_ = nullptr
 
ff_interpolation::Operation op_type_ = ff_interpolation::Operation::OP_SUM
 
std::string op_lua_func_
 
double op_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_
 

Private Attributes

std::vector< uint64_t > cell_local_ids_inside_logvol_
 

Detailed Description

Volume-wise field function interpolation.

This interpolator allows the user to obtain quantities by logical volume. If no logical volume is assigned to the method it will default to operating over the entire volume.

The method also supports a few primitive operations:

  • OP_VOLUME_AVG. Obtains the volume average of the field function of interest.
  • OP_VOLUME_SUM. Obtains the volume integral of the field function of interest.

Definition at line 21 of file chi_ffinter_volume.h.

Constructor & Destructor Documentation

◆ FieldFunctionInterpolationVolume()

chi_mesh::FieldFunctionInterpolationVolume::FieldFunctionInterpolationVolume ( )
inline

Definition at line 34 of file chi_ffinter_volume.h.

Member Function Documentation

◆ CallLuaFunction()

double chi_mesh::FieldFunctionInterpolationVolume::CallLuaFunction ( double  ff_value,
int  mat_id 
) const

Calls the designated lua function

Definition at line 8 of file chi_ffinter_volume_calllua.cc.

◆ Execute()

void chi_mesh::FieldFunctionInterpolationVolume::Execute ( )
overridevirtual

Executes the volume interpolation.

Reimplemented from chi_mesh::FieldFunctionInterpolation.

Definition at line 11 of file chi_ffinter_volume_execute.cc.

◆ ExportPython()

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

Implements chi_mesh::FieldFunctionInterpolation.

Definition at line 56 of file chi_ffinter_volume.h.

◆ GetDefaultFileBaseName()

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

Implements chi_mesh::FieldFunctionInterpolation.

Definition at line 54 of file chi_ffinter_volume.h.

◆ GetLogicalVolume()

std::shared_ptr< chi_mesh::LogicalVolume > & chi_mesh::FieldFunctionInterpolationVolume::GetLogicalVolume ( )
inline

Definition at line 38 of file chi_ffinter_volume.h.

◆ GetOperationLuaFunction()

std::string & chi_mesh::FieldFunctionInterpolationVolume::GetOperationLuaFunction ( )
inline

Definition at line 42 of file chi_ffinter_volume.h.

◆ GetOperationType()

ff_interpolation::Operation & chi_mesh::FieldFunctionInterpolationVolume::GetOperationType ( )
inline

Definition at line 40 of file chi_ffinter_volume.h.

◆ GetOpValue()

double & chi_mesh::FieldFunctionInterpolationVolume::GetOpValue ( )
inline

Definition at line 44 of file chi_ffinter_volume.h.

◆ Initialize()

void chi_mesh::FieldFunctionInterpolationVolume::Initialize ( )
overridevirtual

Initializes the volume field function interpolation.

Reimplemented from chi_mesh::FieldFunctionInterpolation.

Definition at line 12 of file chi_ffinter_volume_initialize.cc.

Field Documentation

◆ cell_local_ids_inside_logvol_

std::vector<uint64_t> chi_mesh::FieldFunctionInterpolationVolume::cell_local_ids_inside_logvol_
private

Definition at line 31 of file chi_ffinter_volume.h.

◆ logical_volume_

std::shared_ptr<chi_mesh::LogicalVolume> chi_mesh::FieldFunctionInterpolationVolume::logical_volume_ = nullptr
protected

Definition at line 25 of file chi_ffinter_volume.h.

◆ op_lua_func_

std::string chi_mesh::FieldFunctionInterpolationVolume::op_lua_func_
protected

Definition at line 27 of file chi_ffinter_volume.h.

◆ op_type_

ff_interpolation::Operation chi_mesh::FieldFunctionInterpolationVolume::op_type_ = ff_interpolation::Operation::OP_SUM
protected

Definition at line 26 of file chi_ffinter_volume.h.

◆ op_value_

double chi_mesh::FieldFunctionInterpolationVolume::op_value_ = 0.0
protected

Definition at line 28 of file chi_ffinter_volume.h.

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