Class AdiabaticCooling

Inheritance Relationships

Base Type

Class Documentation

class AdiabaticCooling : public Module

Implements adiabatic cooling/heating due to advection.

Public Functions

AdiabaticCooling(ref_ptr<AdvectionField> advectionField)

Default constructor.

Parameters:

advectionField – The advection field used for the adiabatic energy change

AdiabaticCooling(ref_ptr<AdvectionField> advectionField, double limit)

Constructor

Parameters:

  • advectionField – The advection field used for the adiabatic energy change

  • limit – Maximum relative energy change allowed

virtual void process(Candidate *c) const

Process function This is the main function to work with, it is called during every ModuleList::run step. Derived functions need to override this overload of process!

Parameters:

candidate – Candidate raw pointer

void setLimit(double l)
double getLimit() const
virtual std::string getDescription() const

Returns description, can be overriden by derived class.

void setDescription(const std::string &description)

Sets description, can be used instead of getDescription in derived class

Parameters:

description – Description string

inline void process(ref_ptr<Candidate> candidate) const

Process function Overload for process function to explicitly make a conversion from ref_ptr to a raw pointer

inline size_t addReference() const
inline size_t removeReference() const
inline int removeReferenceNoDelete() const
inline size_t getReferenceCount() const

Protected Attributes

mutable size_t _referenceCount