Flow123d  master-f44eb46
Classes | Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
HeatTransferModel Class Referenceabstract

#include <heat_model.hh>

Inheritance diagram for HeatTransferModel:
Inheritance graph
[legend]
Collaboration diagram for HeatTransferModel:
Collaboration graph
[legend]

Classes

class  ModelEqData
 
class  ModelEqFields
 

Public Types

typedef AdvectionProcessBase FactoryBaseType
 
- Public Types inherited from AdvectionDiffusionModel
enum  Abstract_bc_types { abc_inflow , abc_dirichlet , abc_total_flux , abc_diffusive_flux }
 

Public Member Functions

 HeatTransferModel (Mesh &mesh, const Input::Record in_rec)
 
void init_from_input (const Input::Record &) override
 Read necessary data from input record. More...
 
 ~HeatTransferModel () override
 
virtual ModelEqFieldseq_fields ()=0
 Derived class should implement getter for ModelEqFields instance. More...
 
virtual ModelEqDataeq_data ()=0
 Derived class should implement getter for ModelEqData instance. More...
 
- Public Member Functions inherited from AdvectionDiffusionModel
virtual ~AdvectionDiffusionModel ()
 Destructor. More...
 
- Public Member Functions inherited from AdvectionProcessBase
 AdvectionProcessBase (Mesh &mesh, const Input::Record in_rec)
 
- Public Member Functions inherited from EquationBase
 EquationBase ()
 
 EquationBase (Mesh &mesh, const Input::Record in_rec)
 
virtual void initialize ()
 
virtual void zero_time_step ()
 
virtual ~EquationBase ()
 
virtual void update_solution ()
 
virtual void choose_next_time ()
 
virtual void set_time_upper_constraint (double dt, std::string message)
 
virtual void set_time_lower_constraint (double dt, std::string message)
 
TimeGovernortime ()
 
virtual void set_time_governor (TimeGovernor &time)
 
double planned_time ()
 
virtual double solved_time ()
 
Meshmesh ()
 
std::shared_ptr< Balancebalance () const
 
TimeMark::Type mark_type ()
 
FieldSeteq_fieldset ()
 
std::shared_ptr< FieldSeteq_fieldset_ptr ()
 
virtual void output_data ()
 Write computed fields. More...
 
void init_user_fields (Input::Array user_fields, FieldSet &output_fields)
 

Protected Member Functions

virtual void calculate_cumulative_balance ()=0
 
void init_balance (const Input::Record &in_rec)
 

Static Protected Member Functions

static IT::Record get_input_type (const string &implementation, const string &description)
 

Protected Attributes

std::shared_ptr< OutputTimeoutput_stream_
 
- Protected Attributes inherited from EquationBase
bool equation_empty_
 flag is true if only default constructor was called More...
 
Meshmesh_
 
TimeGovernortime_
 
Input::Record input_record_
 
std::shared_ptr< FieldSeteq_fieldset_
 
std::shared_ptr< Balancebalance_
 object for calculation and writing the mass balance to file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from AdvectionProcessBase
static Input::Type::Abstractget_input_type ()
 Common specification of the input record for secondary equations. More...
 
- Static Public Member Functions inherited from EquationBase
static Input::Type::Recordrecord_template ()
 Template Record with common keys for derived equations. More...
 
static Input::Type::Recorduser_fields_template (std::string equation_name)
 Template Record with common key user_fields for derived equations. More...
 

Detailed Description

Definition at line 96 of file heat_model.hh.

Member Typedef Documentation

◆ FactoryBaseType

Definition at line 233 of file heat_model.hh.

Constructor & Destructor Documentation

◆ HeatTransferModel()

HeatTransferModel::HeatTransferModel ( Mesh mesh,
const Input::Record  in_rec 
)

Definition at line 433 of file heat_model.cc.

◆ ~HeatTransferModel()

HeatTransferModel::~HeatTransferModel ( )
override

Definition at line 454 of file heat_model.cc.

Member Function Documentation

◆ calculate_cumulative_balance()

virtual void HeatTransferModel::calculate_cumulative_balance ( )
protectedpure virtual

◆ eq_data()

virtual ModelEqData& HeatTransferModel::eq_data ( )
pure virtual

Derived class should implement getter for ModelEqData instance.

Here is the caller graph for this function:

◆ eq_fields()

virtual ModelEqFields& HeatTransferModel::eq_fields ( )
pure virtual

Derived class should implement getter for ModelEqFields instance.

◆ get_input_type()

IT::Record HeatTransferModel::get_input_type ( const string &  implementation,
const string &  description 
)
staticprotected

Create input type that can be passed to the derived class.

Parameters
implementationString characterizing the numerical method, e.g. DG, FEM, FVM.
descriptionComment used to describe the record key.
Returns

Definition at line 419 of file heat_model.cc.

◆ init_balance()

void HeatTransferModel::init_balance ( const Input::Record in_rec)
protected

Temporary method, sets balance object after construction of EqData object.

Definition at line 444 of file heat_model.cc.

◆ init_from_input()

void HeatTransferModel::init_from_input ( const Input::Record in_rec)
inlineoverridevirtual

Read necessary data from input record.

Implements AdvectionDiffusionModel.

Definition at line 238 of file heat_model.hh.

Member Data Documentation

◆ output_stream_

std::shared_ptr<OutputTime> HeatTransferModel::output_stream_
protected

Definition at line 265 of file heat_model.hh.


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