TimeStep Class Reference

The TimeStep class is a subclass of BoundaryConditions with an extra member to store the timestamp of the boundary conditions. More...

#include <boundaryconditions.hpp>

Inheritance diagram for TimeStep:

Public Member Functions
	TimeStep (const arma::uword timestamp, const BoundaryConditions &boundaryConditions)
	Construct from timestamp and BoundaryConditions instance. More...
arma::uword	timestamp () const
	Get (copy of) timestamp.
Public Member Functions inherited from BoundaryConditions
	BoundaryConditions ()
	BoundaryConditions with no properties set.
	BoundaryConditions (const arma::mat &boundaryConditionMat, const Composition &inletComposition=Composition::defaultComposition, const Composition &outletComposition=Composition::defaultComposition)
	Constructor with defaults for inlet and outlet composition. More...
	BoundaryConditions (const double inletFlow, const double outletFlow, const double inletPressure, const double outletPressure, const double inletTemperature, const double outletTemperature, const Composition &inletComposition=Composition::defaultComposition, const Composition &outletComposition=Composition::defaultComposition)
	Construct from arma::vec for each property at inlet and outlet, and composition. More...
	BoundaryConditions (const Pipeline &pipeline, const std::vector< std::string > &boundarySettings={"inlet", "outlet", "inlet"})
	Construct from a Pipeline object. More...
void	setBoundarySettings (const std::vector< std::string > &strings)
	Set boundary settings via vector of string, or brace-init-list like {"inlet", "outlet", "inlet"} More...
arma::uword	nActiveBoundaryConditions () const
	Returns the number of active boundary conditions.
const auto &	inletFlow () const
	Get inlet flow [kg/s].
const auto &	outletFlow () const
	Get outlet flow [kg/s].
const auto &	inletPressure () const
	Get inlet pressure [Pa].
const auto &	outletPressure () const
	Get outlet pressure [Pa].
const auto &	inletTemperature () const
	Get inlet temperature [K].
const auto &	outletTemperature () const
	Get outlet temperature [k].
const Composition &	inletComposition () const
	Get inlet Composition.
const Composition &	outletComposition () const
	Get outlet Composition.
auto &	inletFlow ()
	Get inlet flow [kg/s].
auto &	outletFlow ()
	Get outlet flow [kg/s].
auto &	inletPressure ()
	Get inlet pressure [Pa].
auto &	outletPressure ()
	Get outlet pressure [Pa].
auto &	inletTemperature ()
	Get inlet temperature [K].
auto &	outletTemperature ()
	Get outlet temperature [k].
Composition &	inletComposition ()
	Inlet Composition setter.
Composition &	outletComposition ()
	Outlet Composition setter.
const auto &	inlet (const arma::uword i) const
const auto &	outlet (const arma::uword i) const
	BoundaryConditions (const SingleCondition inletFlow, const SingleCondition outletFlow, const SingleCondition inletPressure, const SingleCondition outletPressure, const SingleCondition inletTemperature, const SingleCondition outletTemperature, const Composition &inletComposition=Composition::defaultComposition, const Composition &outletComposition=Composition::defaultComposition)
	Construct BoundaryConditions::SingleCondition for each property at inlet and outlet, and composition. More...

Private Attributes
arma::uword	m_timestamp
	Timestamp [s].

Detailed Description

The TimeStep class is a subclass of BoundaryConditions with an extra member to store the timestamp of the boundary conditions.

Constructor & Destructor Documentation

TimeStep()

TimeStep::TimeStep ( const arma::uword  timestamp, const BoundaryConditions &  boundaryConditions  )

inline

Construct from timestamp and BoundaryConditions instance.

Parameters

timestamp	Timestamp [s]
boundaryConditions	BoundaryConditions instance

---

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

• D:/Code/transient-pipeline-flow-gh-pages/src/solver/boundaryconditions.hpp