dynLattice
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
SpringMassModel Class Reference

Model for spring-mass systems at domain boundaries. More...

#include "SpringMassModel.h"

Inheritance diagram for SpringMassModel:
Inheritance graph
[legend]
Collaboration diagram for SpringMassModel:
Collaboration graph
[legend]

Public Member Functions

 SpringMassModel (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
 Constructor.
 
virtual bool takeAction (const String &action, const Properties &params, const Properties &globdat) override
 Handle model actions.
 

Static Public Member Functions

static Ref< Model > makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
 Create new SpringMassModel instance.
 
static void declare ()
 Declare model type to factory.
 

Static Public Attributes

Property identifiers
static const char * TYPE_NAME = "SpringMass"
 Model type name.
 
static const char * BOUNDARY_PROP = "boundary"
 Boundary specification property.
 
static const char * SPRING_NAMES = "springs"
 Spring names property.
 
static const char * EXTENT_VECTOR_PROP = "extentVector"
 Extent vector property.
 
static const char * N_ELEM_PROP = "nElem"
 Number of elements property.
 
static const char * P_ELEM_PROP = "pElem"
 Element parameter property.
 

Protected Member Functions

virtual ~SpringMassModel ()
 Protected destructor.
 
virtual bool applyConstraints_ (const Properties &globdat) const
 Apply constraints to the spring-mass system.
 

Detailed Description

The SpringMassModel emulates singular beams at boundaries to create spring-mass systems for boundary condition modeling. It automatically generates spring elements along specified boundaries and manages child model instances for the spring elements.

Features:

Constructor & Destructor Documentation

◆ SpringMassModel()

SpringMassModel::SpringMassModel ( const String &  name,
const Properties &  conf,
const Properties &  props,
const Properties &  globdat 
)
explicit
Parameters
nameModel name
confActually used configuration properties (output)
propsUser-specified model properties
globdatGlobal data container

◆ ~SpringMassModel()

SpringMassModel::~SpringMassModel ( )
protectedvirtual

Member Function Documentation

◆ applyConstraints_()

bool SpringMassModel::applyConstraints_ ( const Properties &  globdat) const
protectedvirtual
Parameters
globdatGlobal data container
Returns
true if constraints were applied successfully

◆ declare()

void SpringMassModel::declare ( )
static

◆ makeNew()

Ref< Model > SpringMassModel::makeNew ( const String &  name,
const Properties &  conf,
const Properties &  props,
const Properties &  globdat 
)
static
Parameters
nameModel name
confActually used configuration properties (output)
propsUser-specified model properties
globdatGlobal data container
Returns
New model instance

◆ takeAction()

bool SpringMassModel::takeAction ( const String &  action,
const Properties &  params,
const Properties &  globdat 
)
overridevirtual
Parameters
actionAction name
paramsAction parameters
globdatGlobal data container
Returns
true if action was handled

Member Data Documentation

◆ BOUNDARY_PROP

const char * SpringMassModel::BOUNDARY_PROP = "boundary"
static

◆ EXTENT_VECTOR_PROP

const char * SpringMassModel::EXTENT_VECTOR_PROP = "extentVector"
static

◆ N_ELEM_PROP

const char * SpringMassModel::N_ELEM_PROP = "nElem"
static

◆ P_ELEM_PROP

const char * SpringMassModel::P_ELEM_PROP = "pElem"
static

◆ SPRING_NAMES

const char * SpringMassModel::SPRING_NAMES = "springs"
static

◆ TYPE_NAME

const char * SpringMassModel::TYPE_NAME = "SpringMass"
static