stochastic::StochasticModel Class Reference

#include <stochastic_model.h>

Inheritance diagram for stochastic::StochasticModel:

Public Member Functions
	StochasticModel ()=default
virtual	~StochasticModel ()
	StochasticModel (const StochasticModel &)=delete
StochasticModel &	operator= (const StochasticModel &)=delete
std::string	model_name () const
virtual utilities::JsonObject	generate (const std::string &event_name, bool g_units=false)=0
virtual bool	generate (const std::string &event_name, const std::string &output_location, bool g_units=false)=0

Protected Attributes
std::string	model_name_ = "StochasticModel"

Detailed Description

Abstract base class for stochastic models

Definition at line 12 of file stochastic_model.h.

Constructor & Destructor Documentation

stochastic::StochasticModel::StochasticModel ( )

default

Default constructor

virtual stochastic::StochasticModel::~StochasticModel ( )

inlinevirtual

Virtual destructor

Definition at line 22 of file stochastic_model.h.

stochastic::StochasticModel::StochasticModel ( const StochasticModel &  )

delete

Delete copy constructor

Member Function Documentation

virtual utilities::JsonObject stochastic::StochasticModel::generate ( const std::string &  event_name, bool  g_units = false  )

pure virtual

Generate loading based on stochastic model and store outputs as JSON object

Parameters

[in]	event_name	Name to assign to event
[in]	g_units	Indicates that time histories should be returned in units of g. Defaults to false where time histories are returned in units of m/s^2

Returns

JsonObject containing loading time histories

Implemented in stochastic::VlachosEtAl.

virtual bool stochastic::StochasticModel::generate ( const std::string &  event_name, const std::string &  output_location, bool  g_units = false  )

pure virtual

Generate loading based on stochastic model and write results to file in JSON format

Parameters

[in]	event_name	Name to assign to event
[in,out]	output_location	Location to write outputs to
[in]	g_units	Indicates that time histories should be returned in units of g. Defaults to false where time histories are returned in units of m/s^2

Returns

Returns true if successful, false otherwise

Implemented in stochastic::VlachosEtAl.

std::string stochastic::StochasticModel::model_name ( ) const

inline

Get the name of the stochastic model

Returns

Model name as a string

Definition at line 38 of file stochastic_model.h.

StochasticModel& stochastic::StochasticModel::operator= ( const StochasticModel &  )

delete

Delete assignment operator

Member Data Documentation

std::string stochastic::StochasticModel::model_name_ = "StochasticModel"

protected

Name of stochastic model

Definition at line 67 of file stochastic_model.h.

---

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

• include/stochastic_model.h