amr_wind::ib::ImmersedBoundaryModel Class Reference

#include <IBModel.H>

Inheritance diagram for amr_wind::ib::ImmersedBoundaryModel:

Collaboration diagram for amr_wind::ib::ImmersedBoundaryModel:

Public Member Functions
	~ImmersedBoundaryModel () 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_ib ()=0
virtual void	update_positions ()=0
virtual void	update_velocities ()=0
virtual void	compute_forces ()=0
virtual void	prepare_outputs (const std::string &)=0
virtual void	write_outputs ()=0
Public Member Functions inherited from amr_wind::Factory< ImmersedBoundaryModel, 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< ImmersedBoundaryModel, CFDSim &, const std::string &, const int >
static std::unique_ptr< ImmersedBoundaryModel >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

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

Detailed Description

Abstract representation of an immersed boundary in the flow field.

This class is intended to represent a single object (e.g., floating platform, tower complex terrain) that exists in the computational domain. A collection of immersed boundary objects (e.g., multiple cylinders) is modeled using the amr_wind::IB physics class that holds a collection of instances of IBModel and acts on them.

Constructor & Destructor Documentation

~ImmersedBoundaryModel()

amr_wind::ib::ImmersedBoundaryModel::~ImmersedBoundaryModel ( )

overridedefault

Member Function Documentation

base_identifier()

static std::string amr_wind::ib::ImmersedBoundaryModel::base_identifier ( )

inlinestatic

compute_forces()

virtual void amr_wind::ib::ImmersedBoundaryModel::compute_forces ( )

pure virtual

id()

virtual int amr_wind::ib::ImmersedBoundaryModel::id ( ) const

pure virtual

init_ib()

virtual void amr_wind::ib::ImmersedBoundaryModel::init_ib ( )

pure virtual

label()

virtual const std::string & amr_wind::ib::ImmersedBoundaryModel::label ( ) const

pure virtual

prepare_outputs()

virtual void amr_wind::ib::ImmersedBoundaryModel::prepare_outputs ( const std::string & )

pure virtual

read_inputs()

virtual void amr_wind::ib::ImmersedBoundaryModel::read_inputs ( const ::amr_wind::utils::MultiParser & )

pure virtual

update_positions()

virtual void amr_wind::ib::ImmersedBoundaryModel::update_positions ( )

pure virtual

update_velocities()

virtual void amr_wind::ib::ImmersedBoundaryModel::update_velocities ( )

pure virtual

write_outputs()

virtual void amr_wind::ib::ImmersedBoundaryModel::write_outputs ( )

pure virtual

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/immersed_boundary/IBModel.H