BodyForce Class Reference

#include <BodyForce.h>

Collaboration diagram for BodyForce:

Public Types
enum	temperatureBoundaryConditionOptionEnum { temperatureBoundaryConditionIsConstantCoefficients, temperatureBoundaryConditionIsVariableCoefficients }
enum	bodyTemperatureOptionEnum { adiabaticBody =0, isothermalBody, conductingBody }

Public Member Functions
	BodyForce ()
	~BodyForce ()
virtual int	get (const GenericDataBase &dir, const aString &name)
	Get the BodyForce object from the database.
virtual int	put (GenericDataBase &dir, const aString &name) const
	Put the BodyForce object into the database.

Static Public Member Functions
static int	plotForcingRegions (GenericGraphicsInterface &gi, DataBase &dbase, CompositeGrid &cg, GraphicsParameters &psp)
	Plot body/boundary forcing regions and immersed boundaries.

Public Attributes
DataBase	dbase

Member Enumeration Documentation

enum BodyForce::bodyTemperatureOptionEnum

Enumerator
adiabaticBody
isothermalBody
conductingBody

enum BodyForce::temperatureBoundaryConditionOptionEnum

Enumerator
temperatureBoundaryConditionIsConstantCoefficients
temperatureBoundaryConditionIsVariableCoefficients

Constructor & Destructor Documentation

BodyForce::BodyForce

(

)

References aString, dbase, DBase::DataBase::get(), DBase::DataBase::has_key(), and DBase::DataBase::put().

BodyForce::~BodyForce

(

)

Member Function Documentation

int BodyForce::get ( const GenericDataBase &  dir, const aString &  name  )

virtual

Get the BodyForce object from the database.

References aString, dbase, GenericDataBase::find(), GenericDataBase::get(), DBase::DataBase::get(), DBase::DataBase::has_key(), DBase::DataBase::put(), and GenericDataBase::virtualConstructor().

Referenced by ShowFilePlotter::plot().

int BodyForce::plotForcingRegions ( GenericGraphicsInterface &  gi, DataBase &  dbase, CompositeGrid &  cg, GraphicsParameters &  pspGlobal  )

static

Plot body/boundary forcing regions and immersed boundaries.

We interactively check for answers if the calling program has set GI_PLOT_THE_OBJEC to false, otherwise we plot the regions and exit.

Parameters

dbase	(input) : DataBase holding the lists of body and boundary forcings.
cg	(input) : the current grid.

References SelectionInfo::active, DialogData::addOptionMenu(), aString, axis1, axis2, axis3, PlotIt::buildColourDialog(), ce, GraphicsParameters::colourByGrid, PlotIt::contour(), dbase, debug, GraphicsParameters::defaultColour, GenericGraphicsInterface::erase(), DBase::DataBase::get(), GraphicsParameters::get(), GenericGraphicsInterface::getAnswer(), GraphicsParameters::getBoundaryColourOption(), PlotIt::getColour(), GUIState::getDialogSibling(), ReferenceCounting::getGlobalID(), DialogData::getOptionMenu(), DialogData::getToggleValue(), getXColour(), GI_BLOCK_BOUNDARY_COLOUR_OPTION, GI_BOUNDARY_COLOUR_OPTION, GI_MAPPING_COLOUR, GI_PLOT_BLOCK_BOUNDARIES, GI_PLOT_LINES_ON_MAPPING_BOUNDARIES, GI_PLOT_MAPPING_EDGES, GI_PLOT_SHADED_MAPPING_BOUNDARIES, GI_PLOT_THE_OBJECT_AND_EXIT, SelectionInfo::globalID, DBase::DataBase::has_key(), DialogData::hideSibling(), GenericGraphicsInterface::isInteractiveGraphicsOn(), SelectionInfo::nSelect, GridCollection::numberOfDimensions(), GenericGraphicsInterface::outputToCommandFile(), PlotIt::plot(), GenericGraphicsInterface::popGUI(), printF(), GenericGraphicsInterface::pushGUI(), DBase::DataBase::put(), GenericGraphicsInterface::savePickCommands(), SelectionInfo::selection, GraphicsParameters::set(), OptionMenu::setCurrentChoice(), DialogData::setExitCommand(), Mapping::setGridDimensions(), DialogData::setPushButtons(), DialogData::setToggleButtons(), DialogData::setWindowTitle(), DialogData::showSibling(), sPrintF(), sScanF(), and GenericGraphicsInterface::stopReadingCommandFile().

Referenced by ShowFilePlotter::plot(), and ShowFilePlotter::plotAll().

int BodyForce::put ( GenericDataBase &  dir, const aString &  name  ) const

virtual

Put the BodyForce object into the database.

References aString, GenericDataBase::create(), dbase, DBase::DataBase::get(), GenericDataBase::put(), and GenericDataBase::virtualConstructor().

Member Data Documentation

DataBase BodyForce::dbase

Referenced by BodyForce(), get(), plotForcingRegions(), and put().

---

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

• BodyForce.h
• BodyForce.C