kynema_sgf::ib::IBModel< GeomTrait > Class Template Reference

#include <IBModel.H>

Inheritance diagram for kynema_sgf::ib::IBModel< GeomTrait >:

Collaboration diagram for kynema_sgf::ib::IBModel< GeomTrait >:

Public Member Functions
	IBModel (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_positions () override
void	update_velocities () override
void	compute_forces () override
void	prepare_outputs (const std::string &out_dir) override
void	write_outputs () override
void	init_ib () override

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

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

Detailed Description

template<typename GeomTrait>
class kynema_sgf::ib::IBModel< GeomTrait >

Concrete implementation of the IBModel for different geometry types.

Template Parameters

GeomTrait

A geometry type trait that defines the behavior of the different actions (initialization, velocity update, force computation) that are executed by the IBModel class through the kynema_sgf::ib physics driver class.

Constructor & Destructor Documentation

IBModel()

template<typename GeomTrait>

kynema_sgf::ib::IBModel< GeomTrait >::IBModel ( 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

compute_forces()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::compute_forces ( )

inlineoverride

id()

template<typename GeomTrait>

int kynema_sgf::ib::IBModel< GeomTrait >::id ( ) const

inlinenodiscardoverride

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

identifier()

template<typename GeomTrait>

std::string kynema_sgf::ib::IBModel< GeomTrait >::identifier ( )

inlinestatic

init_ib()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::init_ib ( )

inlineoverride

label()

template<typename GeomTrait>

const std::string & kynema_sgf::ib::IBModel< GeomTrait >::label ( ) const

inlinenodiscardoverride

Return the unique identifier (name) for this instance.

prepare_outputs()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::prepare_outputs ( const std::string & out_dir )

inlineoverride

read_inputs()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::read_inputs ( const ::kynema_sgf::utils::MultiParser & pp )

inlineoverride

update_positions()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::update_positions ( )

inlineoverride

update_velocities()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::update_velocities ( )

inlineoverride

write_outputs()

template<typename GeomTrait>

void kynema_sgf::ib::IBModel< GeomTrait >::write_outputs ( )

inlineoverride

Member Data Documentation

m_data

template<typename GeomTrait>

GeomTrait::DataType kynema_sgf::ib::IBModel< GeomTrait >::m_data

private

Instance that holds all data related to a particular immersed boundary type.

m_out_op

template<typename GeomTrait>

ops::ProcessOutputsOp<GeomTrait> kynema_sgf::ib::IBModel< GeomTrait >::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/immersed_boundary/IBModel.H