YAMLParser
Public Member Functions | Public Attributes | List of all members
FEBeam Class Reference

#include <FEBeam.h>

Inheritance diagram for FEBeam:
GenericFE Identifiable

Public Member Functions

 FEBeam (int id, FENode *node1, FENode *node2, GenericMaterial *mat, GenericCrossSection *crossSection, FEEccentricity *ecc1, FEEccentricity *ecc2, FEVector *vec)
 
 ~FEBeam ()
 
Identifiable::Type getType ()
 
virtual std::string getTypeAsString () override
 
bool assignIndependentAttributes (YAML::Node &yamlNode) override
 
void printAttributes ()
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
int getID () const
 Getter for the externally defined identification number. More...
 

Public Attributes

const FENodepNode1
 Ptr to FENode object defining the start point of the beam. More...
 
const FENodepNode2
 Ptr to FENode object defining the end point of the beam. More...
 
const GenericMaterialpMaterial
 Ptr to material object. More...
 
const GenericCrossSectionpCrossSection
 Ptr to object holding the cross-sectional data. More...
 
const FEEccentricitypEcc1
 Ptr to eccentricity information for node 1. More...
 
const FEEccentricitypEcc2
 Ptr to eccentricity information for node 2. More...
 
const FEVectorpVec
 Ptr to FEVector object specifying the beam's orientation. More...
 
- Public Attributes inherited from Identifiable
std::vector< std::string > s_Types
 
Type type
 The FEM element type (see enum definition) More...
 

Additional Inherited Members

- Public Types inherited from Identifiable
enum  Type {
  NULLTYPE, NODE, COORDSYS, BEAM,
  TRISHELL, QUADSHEL, VECTOR, ECCENT,
  ISOMATERIAL, PIPE, BOX, IHPROFIL,
  LSECTION, TSECTION, PLCOMP, CROSS_SECTION_DUMMY,
  NODELOAD, LOADCOMB
}
 
- Protected Member Functions inherited from Identifiable
void setID (int id)
 Setter for the externally defined identification number. More...
 
- Protected Attributes inherited from Identifiable
int id
 Externally defined identification number. More...
 

Constructor & Destructor Documentation

◆ FEBeam()

FEBeam::FEBeam ( int  id,
FENode node1,
FENode node2,
GenericMaterial mat,
GenericCrossSection crossSection,
FEEccentricity ecc1,
FEEccentricity ecc2,
FEVector vec 
)

This is the class constructor. It simply populates the attributes with data from the function argument list.

◆ ~FEBeam()

FEBeam::~FEBeam ( )

Member Function Documentation

◆ assignIndependentAttributes()

bool FEBeam::assignIndependentAttributes ( YAML::Node &  yamlNode)
overridevirtual

This function is inherited from GenericFE. This function does nothing. The only independent attributes for the BEAM record is the id, but this attribute is not assigned in this function. Rather, the id is passed as an integer in the constructor because passing an integer is more effective than passing a YAML::Node.

This method is implemented to ensure consistency with the base class.

Implements GenericFE.

◆ getType()

Identifiable::Type FEBeam::getType ( )
virtual

Function returning the type of the element.
Used to specify element types for operatins such as comparison.

Reimplemented from Identifiable.

◆ getTypeAsString()

std::string FEBeam::getTypeAsString ( )
overridevirtual

Function returning the type as a string.
Used to throw informative error messages

Reimplemented from Identifiable.

◆ printAttributes()

void FEBeam::printAttributes ( )
virtual

Print attributes to console

Implements GenericFE.

Member Data Documentation

◆ pCrossSection

const GenericCrossSection* FEBeam::pCrossSection

Ptr to object holding the cross-sectional data.

◆ pEcc1

const FEEccentricity* FEBeam::pEcc1

Ptr to eccentricity information for node 1.

◆ pEcc2

const FEEccentricity* FEBeam::pEcc2

Ptr to eccentricity information for node 2.

◆ pMaterial

const GenericMaterial* FEBeam::pMaterial

Ptr to material object.

◆ pNode1

const FENode* FEBeam::pNode1

Ptr to FENode object defining the start point of the beam.

◆ pNode2

const FENode* FEBeam::pNode2

Ptr to FENode object defining the end point of the beam.

◆ pVec

const FEVector* FEBeam::pVec

Ptr to FEVector object specifying the beam's orientation.


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