src/DiffEq/Dissipation/DissipationCoeffPolicy.hpp file

Particle dissipation equation coefficients policies.

Contents

General requirements on dissipation equation coefficients policy classes:

  • Must define a constructor, which is used to initialize the SDE coefficient, C0. Required signature:

    CoeffPolicyName(
      kw::sde_c3::info::expect::type c3_,
      kw::sde_c4::info::expect::type c4_,
      kw::sde_com1::info::expect::type com1_,
      kw::sde_com2::info::expect::type com2_,
      kw::sde_c3::info::expect::type& c3,
      kw::sde_c4::info::expect::type& c4,
      kw::sde_com1::info::expect::type& com1,
      kw::sde_com2::info::expect::type& com2 )
  • Must define the static function type(), returning the enum value of the policy option. Example:

    static ctr::CoeffPolicyType type() noexcept {
      return ctr::CoeffPolicyType::CONST_COEFF;
    }

    which returns the enum value of the option from the underlying option class, collecting all possible options for coefficients policies.

  • Must define the static function src(), with the signature void src( tk::real& Som () {} which sets its argument Som to the level of the source of the dissipation equation. This member function must be static as it is called without an object instance.

Namespaces

namespace walker
Walker declarations and definitions.

Classes

class walker::DissipationCoeffConst
Dissipation equation coefficients policy keeping the coefficients constant.
class walker::DissipationCoeffStationary
Dissipation equation coefficients policy keeping the dissipation rate in a constant statistically stationary state.