amr_wind::ocean_waves::OceanWavesModel Class Reference

#include <OceanWavesModel.H>

Inheritance diagram for amr_wind::ocean_waves::OceanWavesModel:

Collaboration diagram for amr_wind::ocean_waves::OceanWavesModel:

Public Member Functions
	~OceanWavesModel () override=default
virtual const std::string &	label () const =0
virtual int	id () const =0
virtual void	read_inputs (const ::amr_wind::utils::MultiParser &)=0
virtual void	init_waves (int, const amrex::Geometry &)=0
virtual void	update_relax_zones ()=0
virtual void	apply_relax_zones ()=0
virtual void	prepare_outputs (const std::string &)=0
virtual void	write_outputs ()=0
virtual void	record_regrid_flag ()=0
virtual void	reset_regrid_flag ()=0
Public Member Functions inherited from amr_wind::Factory< OceanWavesModel, CFDSim &, const std::string &, const int >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	base_identifier ()
Static Public Member Functions inherited from amr_wind::Factory< OceanWavesModel, CFDSim &, const std::string &, const int >
static std::unique_ptr< OceanWavesModel >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

Additional Inherited Members
Public Attributes inherited from amr_wind::Factory< OceanWavesModel, CFDSim &, const std::string &, const int >
friend	Base

Detailed Description

Abstract representation of a wave model used for wave generation

This class is intended to represent a single wave model

Constructor & Destructor Documentation

~OceanWavesModel()

amr_wind::ocean_waves::OceanWavesModel::~OceanWavesModel ( )

overridedefault

Member Function Documentation

apply_relax_zones()

virtual void amr_wind::ocean_waves::OceanWavesModel::apply_relax_zones ( )

pure virtual

base_identifier()

static std::string amr_wind::ocean_waves::OceanWavesModel::base_identifier ( )

inlinestatic

id()

virtual int amr_wind::ocean_waves::OceanWavesModel::id ( ) const

pure virtual

init_waves()

virtual void amr_wind::ocean_waves::OceanWavesModel::init_waves ( int , const amrex::Geometry &  )

pure virtual

label()

virtual const std::string & amr_wind::ocean_waves::OceanWavesModel::label ( ) const

pure virtual

prepare_outputs()

virtual void amr_wind::ocean_waves::OceanWavesModel::prepare_outputs ( const std::string & )

pure virtual

read_inputs()

virtual void amr_wind::ocean_waves::OceanWavesModel::read_inputs ( const ::amr_wind::utils::MultiParser & )

pure virtual

record_regrid_flag()

virtual void amr_wind::ocean_waves::OceanWavesModel::record_regrid_flag ( )

pure virtual

reset_regrid_flag()

virtual void amr_wind::ocean_waves::OceanWavesModel::reset_regrid_flag ( )

pure virtual

update_relax_zones()

virtual void amr_wind::ocean_waves::OceanWavesModel::update_relax_zones ( )

pure virtual

write_outputs()

virtual void amr_wind::ocean_waves::OceanWavesModel::write_outputs ( )

pure virtual

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/ocean_waves/OceanWavesModel.H