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

Specialized output module for periodic boundary condition analysis. More...

#include "PBCGroupOutputModule.h"

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

Public Types

Type definitions
typedef PBCGroupOutputModule Self
 Self type alias.
 
typedef GroupOutputModule Super
 Base class type alias.
 

Public Member Functions

 PBCGroupOutputModule (const String &name="pbcGroupOutput")
 Constructor.
 
virtual Status init (const Properties &conf, const Properties &props, const Properties &globdat) override
 Initialize PBC output module.
 
virtual Status run (const Properties &globdat) override
 Run PBC output extraction.
 
virtual void shutdown (const Properties &globdat) override
 Shutdown and finalize output.
 
- Public Member Functions inherited from GroupOutputModule
 GroupOutputModule (const String &name="groupOutput")
 Constructor.
 

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 instances.
 
static void declare ()
 Register module type with factory.
 
static StringVector getDataSets (const idx_t dim, const bool strains=false, const bool stresses=false, const StringVector &dofNames={ "dx", "dy", "dz"})
 Generate strain/stress data set expressions.
 
- Static Public Member Functions inherited from GroupOutputModule
static Ref< Module > makeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
 Factory method for creating new GroupOutputModule instances.
 
static void declare ()
 Register GroupOutputModule type with ModuleFactory.
 

Static Public Attributes

Property identifiers
static const char * TYPE_NAME = "PBCGroupOutput"
 Module type name.
 
static const char * CHILD_NAME = "sampling"
 Child sampling module name.
 
- Static Public Attributes inherited from GroupOutputModule
static const char * TYPE_NAME = "GroupOutput"
 Module type name.
 

Protected Member Functions

String getHeader_ (String existing) const
 Generate CSV header string.
 
StringVector getDataSets_ (StringVector existing) const
 Generate data set expressions.
 
- Protected Member Functions inherited from GroupOutputModule
virtual ~GroupOutputModule ()
 Protected destructor.
 

Protected Attributes

Child modules
Ref< SampleModule > child_
 Child sampling module for data output.
 
- Protected Attributes inherited from GroupOutputModule
StringVector nodeGroups_
 Node groups for singular element force/displacement calculations.
 
StringVector elemGroups_
 Element groups for extent/strain/stress value calculations.
 
StringVector nodeDofNames_
 DOF names for node group calculations.
 
IdxVector nodeDofs_
 DOF indices for node group calculations.
 
StringVector elemDofNames_
 DOF names for element group calculations.
 
IdxVector elemDofs_
 DOF indices for element group calculations.
 

Detailed Description

Extends GroupOutputModule with automatic configuration for PBC simulations. Provides strain and stress extraction from boundary node groups and calculates displacement gradients and stress tensors for homogenization.

Member Typedef Documentation

◆ Self

◆ Super

Constructor & Destructor Documentation

◆ PBCGroupOutputModule()

PBCGroupOutputModule::PBCGroupOutputModule ( const String &  name = "pbcGroupOutput")
explicit
Parameters
nameModule name (default: "pbcGroupOutput")

Member Function Documentation

◆ declare()

void PBCGroupOutputModule::declare ( )
static

◆ getDataSets()

StringVector PBCGroupOutputModule::getDataSets ( const idx_t  dim,
const bool  strains = false,
const bool  stresses = false,
const StringVector &  dofNames = { "dx", "dy", "dz"} 
)
static
Parameters
dimSpatial dimension
strainsInclude strain measures
stressesInclude stress measures
dofNamesDOF names for coordinate directions
Returns
Vector of data set expressions

◆ getDataSets_()

StringVector PBCGroupOutputModule::getDataSets_ ( StringVector  existing) const
protected
Parameters
existingExisting data sets
Returns
Complete data sets with PBC-specific expressions

◆ getHeader_()

String PBCGroupOutputModule::getHeader_ ( String  existing) const
protected
Parameters
existingExisting header content
Returns
Complete header with PBC-specific columns

◆ init()

Module::Status PBCGroupOutputModule::init ( const Properties &  conf,
const Properties &  props,
const Properties &  globdat 
)
overridevirtual
Parameters
confConfiguration properties (output)
propsUser properties
globdatGlobal data container
Returns
Module status

Reimplemented from GroupOutputModule.

◆ makeNew()

Ref< Module > PBCGroupOutputModule::makeNew ( const String &  name,
const Properties &  conf,
const Properties &  props,
const Properties &  globdat 
)
static
Parameters
nameModule name
confConfiguration properties (output)
propsUser properties
globdatGlobal data container
Returns
New module instance

◆ run()

Module::Status PBCGroupOutputModule::run ( const Properties &  globdat)
overridevirtual
Parameters
globdatGlobal data container
Returns
Module status

Reimplemented from GroupOutputModule.

◆ shutdown()

void PBCGroupOutputModule::shutdown ( const Properties &  globdat)
overridevirtual
Parameters
globdatGlobal data container

Member Data Documentation

◆ child_

Ref<SampleModule> PBCGroupOutputModule::child_
protected

◆ CHILD_NAME

const char * PBCGroupOutputModule::CHILD_NAME = "sampling"
static

◆ TYPE_NAME

const char * PBCGroupOutputModule::TYPE_NAME = "PBCGroupOutput"
static