FreeSurfaceDamping Class Reference

Kynema-SGF API: kynema_sgf::FreeSurfaceDamping Class Reference
Kynema-SGF API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches

#include <FreeSurfaceDamping.H>

Inheritance diagram for kynema_sgf::FreeSurfaceDamping:
[legend]
Collaboration diagram for kynema_sgf::FreeSurfaceDamping:
[legend]

Public Member Functions

 FreeSurfaceDamping (CFDSim &)
 ~FreeSurfaceDamping () override
void initialize_fields (int, const amrex::Geometry &) override
void post_init_actions () override
void post_regrid_actions () override
void pre_advance_work () override
void post_advance_work () override

Static Public Member Functions

static std::string identifier ()

Private Attributes

FieldRepom_repo
bool m_vertical_velocity_damping {true}
bool m_volume_fraction_damping {false}
bool m_global_damping {false}
amrex::Real m_time_scale {1.0_rt}
amrex::Real m_length_xlo {0.0_rt}
amrex::Real m_length_xhi {0.0_rt}
amrex::Real m_length_ylo {0.0_rt}
amrex::Real m_length_yhi {0.0_rt}
amrex::Real m_rho1
amrex::Real m_rho2
const SimTimem_time

Constructor & Destructor Documentation

◆ FreeSurfaceDamping()

kynema_sgf::FreeSurfaceDamping::FreeSurfaceDamping ( CFDSim & sim)
explicit

◆ ~FreeSurfaceDamping()

kynema_sgf::FreeSurfaceDamping::~FreeSurfaceDamping ( )
overridedefault

Member Function Documentation

◆ identifier()

std::string kynema_sgf::FreeSurfaceDamping::identifier ( )
inlinestatic

◆ initialize_fields()

void kynema_sgf::FreeSurfaceDamping::initialize_fields ( int ,
const amrex::Geometry &  )
inlineoverride

◆ post_advance_work()

void kynema_sgf::FreeSurfaceDamping::post_advance_work ( )
override

◆ post_init_actions()

void kynema_sgf::FreeSurfaceDamping::post_init_actions ( )
inlineoverride

◆ post_regrid_actions()

void kynema_sgf::FreeSurfaceDamping::post_regrid_actions ( )
inlineoverride

◆ pre_advance_work()

void kynema_sgf::FreeSurfaceDamping::pre_advance_work ( )
inlineoverride

Member Data Documentation

◆ m_global_damping

bool kynema_sgf::FreeSurfaceDamping::m_global_damping {false}
private

◆ m_length_xhi

amrex::Real kynema_sgf::FreeSurfaceDamping::m_length_xhi {0.0_rt}
private

◆ m_length_xlo

amrex::Real kynema_sgf::FreeSurfaceDamping::m_length_xlo {0.0_rt}
private

◆ m_length_yhi

amrex::Real kynema_sgf::FreeSurfaceDamping::m_length_yhi {0.0_rt}
private

◆ m_length_ylo

amrex::Real kynema_sgf::FreeSurfaceDamping::m_length_ylo {0.0_rt}
private

◆ m_repo

FieldRepo& kynema_sgf::FreeSurfaceDamping::m_repo
private

◆ m_rho1

amrex::Real kynema_sgf::FreeSurfaceDamping::m_rho1
private

◆ m_rho2

amrex::Real kynema_sgf::FreeSurfaceDamping::m_rho2
private

◆ m_time

const SimTime& kynema_sgf::FreeSurfaceDamping::m_time
private

◆ m_time_scale

amrex::Real kynema_sgf::FreeSurfaceDamping::m_time_scale {1.0_rt}
private

◆ m_vertical_velocity_damping

bool kynema_sgf::FreeSurfaceDamping::m_vertical_velocity_damping {true}
private

◆ m_volume_fraction_damping

bool kynema_sgf::FreeSurfaceDamping::m_volume_fraction_damping {false}
private

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