kynema::interfaces::cfd::Interface Class Reference

The main interface for controlling the CFD problem. More...

#include <interface.hpp>

Public Types
using	DeviceType = Kokkos::Device< Kokkos::DefaultExecutionSpace, Kokkos::DefaultExecutionSpace::memory_space >

Public Member Functions
	Interface (const InterfaceInput &input)
	Create an Interface from an InterfaceInput configuration object.
bool	Step ()
	Step forward in time one time step.
void	SaveState ()
	Save state for correction step.
void	RestoreState ()
	Restore state for correction step.
void	WriteRestart (const std::filesystem::path &filename) const
	Write restart file.
void	ReadRestart (const std::filesystem::path &filename)
	Read restart file.
void	WriteOutputs () const
	Write current state to output file if configured.

Public Attributes
Model	model
	Kynema class used for model construction.
Turbine	turbine
	Turbine model input/output data.
State< DeviceType >	state
	Kynema class for storing system state.
Elements< DeviceType >	elements
	Kynema class for model elements (beams, masses, springs)
Constraints< DeviceType >	constraints
	Kynema class for constraints tying elements together.
StepParameters	parameters
	Kynema class containing solution parameters.
Solver< DeviceType >	solver
	Kynema class for solving the dynamic system.
State< DeviceType >	state_save
	Kynema class state class for temporarily saving state.
kynema::interfaces::HostState< DeviceType >	host_state
	Host local copy of State.
size_t	current_timestep_ {0}
	Current timestep index.
std::unique_ptr< interfaces::Outputs >	outputs_
	Optional NetCDF output writer.

Detailed Description

The main interface for controlling the CFD problem.

Member Typedef Documentation

DeviceType

using kynema::interfaces::cfd::Interface::DeviceType = Kokkos::Device<Kokkos::DefaultExecutionSpace, Kokkos::DefaultExecutionSpace::memory_space>

Constructor & Destructor Documentation

Interface()

kynema::interfaces::cfd::Interface::Interface ( const InterfaceInput &  input )

explicit

Create an Interface from an InterfaceInput configuration object.

Parameters

input

The input configuration object

Member Function Documentation

ReadRestart()

void kynema::interfaces::cfd::Interface::ReadRestart

(

const std::filesystem::path &

filename

)

Read restart file.

Parameters

filename

The name of the restart file

RestoreState()

void kynema::interfaces::cfd::Interface::RestoreState

(

)

Restore state for correction step.

SaveState()

void kynema::interfaces::cfd::Interface::SaveState

(

)

Save state for correction step.

Step()

bool kynema::interfaces::cfd::Interface::Step

(

)

Step forward in time one time step.

WriteOutputs()

void kynema::interfaces::cfd::Interface::WriteOutputs

(

)

const

Write current state to output file if configured.

WriteRestart()

void kynema::interfaces::cfd::Interface::WriteRestart

(

const std::filesystem::path &

filename

)

const

Write restart file.

Parameters

filename

The name of the restart file

Member Data Documentation

constraints

Constraints<DeviceType> kynema::interfaces::cfd::Interface::constraints

Kynema class for constraints tying elements together.

current_timestep_

size_t kynema::interfaces::cfd::Interface::current_timestep_ {0}

Current timestep index.

elements

Elements<DeviceType> kynema::interfaces::cfd::Interface::elements

Kynema class for model elements (beams, masses, springs)

host_state

kynema::interfaces::HostState<DeviceType> kynema::interfaces::cfd::Interface::host_state

Host local copy of State.

model

Model kynema::interfaces::cfd::Interface::model

Kynema class used for model construction.

outputs_

std::unique_ptr<interfaces::Outputs> kynema::interfaces::cfd::Interface::outputs_

Optional NetCDF output writer.

parameters

StepParameters kynema::interfaces::cfd::Interface::parameters

Kynema class containing solution parameters.

solver

Solver<DeviceType> kynema::interfaces::cfd::Interface::solver

Kynema class for solving the dynamic system.

state

State<DeviceType> kynema::interfaces::cfd::Interface::state

Kynema class for storing system state.

state_save

State<DeviceType> kynema::interfaces::cfd::Interface::state_save

Kynema class state class for temporarily saving state.

turbine

Turbine kynema::interfaces::cfd::Interface::turbine

Turbine model input/output data.

---

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

• /home/runner/work/kynema/kynema/kynema/src/interfaces/cfd/interface.hpp
• /home/runner/work/kynema/kynema/kynema/src/interfaces/cfd/interface.cpp