ForceOutputModule Class Reference

Module for outputting internal, external, and gyroscopic forces. More...

#include "ForceOutputModule.h"

Inheritance diagram for ForceOutputModule:

Collaboration diagram for ForceOutputModule:

Public Member Functions
	ForceOutputModule (const String &name="ForceOutput")
	Constructor.
virtual Status	init (const Properties &conf, const Properties &props, const Properties &globdat) override
	Initialize the module.
virtual Status	run (const Properties &globdat) override
	Run the force output operation.
virtual void	shutdown (const Properties &globdat) override
	Shutdown the module and close output files.

Static Public Member Functions
static Ref< Module >	makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
	Factory method for creating new ForceOutputModule instances.
static void	declare ()
	Register ForceOutputModule type with ModuleFactory.

Static Public Attributes
Property identifiers
static const char *	TYPE_NAME = "ForceOutput"
	Module type name.
static const char *	INT_PROP = "writeIntForce"
	Internal force output property.
static const char *	EXT_PROP = "writeExtForce"
	External force output property.
static const char *	GYRO_PROP = "writeGyroForce"
	Gyroscopic force output property.
static const char *	NODE_PROP = "nodeSet"
	Node set property.

Protected Member Functions
virtual	~ForceOutputModule ()
	Protected destructor.

Detailed Description

Writes force vectors to output files during simulation for post-processing and analysis. Supports selective output of internal forces, external forces, and gyroscopic forces with configurable sampling conditions.

Constructor & Destructor Documentation

ForceOutputModule()

ForceOutputModule::ForceOutputModule ( const String &  name = "ForceOutput" )

explicit

Parameters

name	Module name

~ForceOutputModule()

ForceOutputModule::~ForceOutputModule ( )

protectedvirtual

Member Function Documentation

declare()

void ForceOutputModule::declare ( )

static

init()

Module::Status ForceOutputModule::init ( const Properties &  conf, const Properties &  props, const Properties &  globdat  )

overridevirtual

Parameters

conf	Actually used configuration properties (output)
props	User-specified module properties
globdat	Global data container

Returns

Module status

makeNew()

Ref< Module > ForceOutputModule::makeNew ( const String &  name, const Properties &  conf, const Properties &  props, const Properties &  globdat  )

static

Parameters

name	Module name
conf	Actually used configuration properties (output)
props	User-specified module properties
globdat	Global data container

Returns

Reference to new ForceOutputModule instance

run()

Module::Status ForceOutputModule::run ( const Properties &  globdat )

overridevirtual

Parameters

globdat

Global data container

Returns

Module status

shutdown()

void ForceOutputModule::shutdown ( const Properties &  globdat )

overridevirtual

Parameters

globdat

Global data container

Member Data Documentation

EXT_PROP

const char * ForceOutputModule::EXT_PROP = "writeExtForce"

static

GYRO_PROP

const char * ForceOutputModule::GYRO_PROP = "writeGyroForce"

static

INT_PROP

const char * ForceOutputModule::INT_PROP = "writeIntForce"

static

NODE_PROP

const char * ForceOutputModule::NODE_PROP = "nodeSet"

static

TYPE_NAME

const char * ForceOutputModule::TYPE_NAME = "ForceOutput"

static