Chi-Tech
Public Member Functions | Static Public Member Functions | Private Attributes
ChiObject Class Reference

#include <ChiObject.h>

Inheritance diagram for ChiObject:
chi::GraphPartitioner chi::Material chi::MaterialProperty chi::Plugin chi::PostProcessor chi_math::FunctionDimAToDimB chi_math::NonLinearSolverOptions chi_math::Quadrature chi_math::TimeIntegration chi_mesh::LogicalVolume chi_mesh::MeshGenerator chi_mesh::MeshModifier chi_physics::FieldFunction chi_physics::Solver chi_physics::TimeStepper chi_physics::field_operations::FieldOperation lbs::LBSGroupset

Public Member Functions

 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 ()
 

Private Attributes

size_t stack_id_ = Chi::SIZE_T_INVALID
 

Detailed Description

Definition at line 7 of file ChiObject.h.

Constructor & Destructor Documentation

◆ ChiObject() [1/2]

ChiObject::ChiObject ( )

Default constructor. This will be removed in future.

Definition at line 9 of file ChiObject.cc.

◆ ChiObject() [2/2]

ChiObject::ChiObject ( const chi::InputParameters &  params)
explicit

Constructor with input parameters.

Definition at line 11 of file ChiObject.cc.

◆ ~ChiObject()

virtual ChiObject::~ChiObject ( )
virtualdefault

Member Function Documentation

◆ GetInputParameters()

chi::InputParameters ChiObject::GetInputParameters ( )
static

Returns the input parameters. For the base ChiObject, there are now parameters loaded.

Returns the input parameters.

Definition at line 4 of file ChiObject.cc.

◆ PushOntoStack()

void ChiObject::PushOntoStack ( std::shared_ptr< ChiObject > &  new_object)
virtual

An overridable callback that is called by the ObjectMaker and by default adds the object onto the object stack. This function can be used to place the object on a different stack.

Reimplemented in chi_physics::FieldFunction, and chi::PostProcessor.

Definition at line 17 of file ChiObject.cc.

◆ SetStackID()

void ChiObject::SetStackID ( size_t  stack_id)

Sets the stack id of the object. This allows this object to know its place in the global space.

Definition at line 13 of file ChiObject.cc.

◆ StackID()

size_t ChiObject::StackID ( ) const

Returns the stack id of this object. This can be used with input language to connect objects together.

Definition at line 15 of file ChiObject.cc.

Field Documentation

◆ stack_id_

size_t ChiObject::stack_id_ = Chi::SIZE_T_INVALID
private

Definition at line 10 of file ChiObject.h.

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