kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait > Class Template Reference

#include <OceanWavesModel.H>

Inheritance diagram for kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >:

Collaboration diagram for kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >:

Public Member Functions
	OWModel (CFDSim &sim, const std::string &label, const int id)
const std::string &	label () const override
	Return the unique identifier (name) for this instance.
int	id () const override
	Return the unique tag (integer ID) for this instance.
void	read_inputs (const ::kynema_sgf::utils::MultiParser &pp) override
void	update_target_fields (const amrex::Real time) override
void	apply_relax_zones () override
void	prepare_outputs (const std::string &out_dir) override
void	record_regrid_flag () override
void	reset_regrid_flag () override
void	write_outputs () override
void	init_waves (int level, const amrex::Geometry &geom, bool multiphase_mode) override

Static Public Member Functions
static std::string	identifier ()

Private Attributes
WaveTheoryTrait::DataType	m_data
	Instance that holds all data related to a particular wave type.
ops::ProcessOutputsOp< WaveTheoryTrait >	m_out_op
	Outputs processor.

Detailed Description

template<typename WaveTheoryTrait>
class kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >

Concrete implementation of the WaveModel for different wave theories.

Template Parameters

WaveTheoryTrait

A wave theory trait that defines the behavior of the different actions (initialization, velocity update, free surface update) that are executed by the WaveModel class through the kynema_sgf::ocean_waves physics driver class.

Constructor & Destructor Documentation

OWModel()

template<typename WaveTheoryTrait>

kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::OWModel ( CFDSim & sim, const std::string & label, const int id )

inline

Parameters

sim	CFD simulation environment instance
label	Unique string identifier for this instance
id	Unique integer tag for this instance

Member Function Documentation

apply_relax_zones()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::apply_relax_zones ( )

inlineoverride

id()

template<typename WaveTheoryTrait>

int kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::id ( ) const

inlinenodiscardoverride

Return the unique tag (integer ID) for this instance.

identifier()

template<typename WaveTheoryTrait>

std::string kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::identifier ( )

inlinestatic

init_waves()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::init_waves ( int level, const amrex::Geometry & geom, bool multiphase_mode )

inlineoverride

label()

template<typename WaveTheoryTrait>

const std::string & kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::label ( ) const

inlinenodiscardoverride

Return the unique identifier (name) for this instance.

prepare_outputs()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::prepare_outputs ( const std::string & out_dir )

inlineoverride

read_inputs()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::read_inputs ( const ::kynema_sgf::utils::MultiParser & pp )

inlineoverride

record_regrid_flag()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::record_regrid_flag ( )

inlineoverride

reset_regrid_flag()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::reset_regrid_flag ( )

inlineoverride

update_target_fields()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::update_target_fields ( const amrex::Real time )

inlineoverride

write_outputs()

template<typename WaveTheoryTrait>

void kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::write_outputs ( )

inlineoverride

Member Data Documentation

m_data

template<typename WaveTheoryTrait>

WaveTheoryTrait::DataType kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::m_data

private

Instance that holds all data related to a particular wave type.

m_out_op

template<typename WaveTheoryTrait>

ops::ProcessOutputsOp<WaveTheoryTrait> kynema_sgf::ocean_waves::OWModel< WaveTheoryTrait >::m_out_op

private

Outputs processor.

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/ocean_waves/OceanWavesModel.H