suanPan
ExternalMaterial Class Referencefinal

A ExternalMaterial class. More...

#include <ExternalMaterial.h>

Inheritance diagram for ExternalMaterial:
Collaboration diagram for ExternalMaterial:

Public Member Functions

 ExternalMaterial (unsigned, std::vector< double > &&, void *)
 
 ExternalMaterial (const ExternalMaterial &)
 
 ExternalMaterial (ExternalMaterial &&) noexcept=delete
 
ExternalMaterialoperator= (const ExternalMaterial &)=delete
 
ExternalMaterialoperator= (ExternalMaterial &&) noexcept=delete
 
 ~ExternalMaterial () override
 
bool validate ()
 
int initialize (const shared_ptr< DomainBase > &) override
 
void initialize_history (unsigned) override
 
void set_initial_history (const vec &) override
 
unique_ptr< Materialget_copy () override
 
int update_trial_status (const vec &) override
 
int update_trial_status (const vec &, const vec &) override
 
int commit_status () override
 
int reset_status () override
 
int clear_status () override
 
std::vector< vec > record (OutputType) override
 
- Public Member Functions inherited from Material
 Material (unsigned=0, MaterialType=MaterialType::D0, double=0.)
 
 Material (const Material &)=default
 
 Material (Material &&)=delete
 
Materialoperator= (const Material &)=delete
 
Materialoperator= (Material &&)=delete
 
 ~Material () override=default
 
double get_density () const
 
MaterialType get_material_type () const
 
PlaneType get_plane_type () const
 
int initialize_base (const shared_ptr< DomainBase > &)
 
virtual int initialize (const shared_ptr< DomainBase > &)=0
 
virtual void initialize_couple (const shared_ptr< DomainBase > &)
 
virtual void initialize_history (unsigned)
 
virtual void set_initial_history (const vec &)
 
void set_initialized (bool) const
 
void set_symmetric (bool) const
 
void set_support_couple (bool) const
 
bool is_initialized () const
 
bool is_symmetric () const
 
bool is_support_couple () const
 
void set_characteristic_length (double) const
 
double get_characteristic_length () const
 
virtual double get_parameter (ParameterType) const
 
virtual const vec & get_trial_strain ()
 
virtual const vec & get_trial_strain_rate ()
 
virtual const vec & get_trial_strain_acc ()
 
virtual const vec & get_trial_stress ()
 
virtual const mat & get_trial_stiffness ()
 
virtual const mat & get_trial_secant ()
 
virtual const mat & get_trial_damping ()
 
virtual const mat & get_trial_inertial ()
 
virtual const vec & get_current_strain ()
 
virtual const vec & get_current_strain_rate ()
 
virtual const vec & get_current_strain_acc ()
 
virtual const vec & get_current_stress ()
 
virtual const mat & get_current_stiffness ()
 
virtual const mat & get_current_secant ()
 
virtual const mat & get_current_damping ()
 
virtual const mat & get_current_inertial ()
 
virtual const vec & get_initial_history () const
 
virtual const mat & get_initial_stiffness () const
 
virtual const mat & get_initial_damping () const
 
virtual const mat & get_initial_inertial () const
 
virtual const vec & get_trial_curvature ()
 
virtual const vec & get_trial_couple_stress ()
 
virtual const mat & get_trial_couple_stiffness ()
 
virtual const vec & get_current_curvature ()
 
virtual const vec & get_current_couple_stress ()
 
virtual const mat & get_current_couple_stiffness ()
 
virtual const mat & get_initial_couple_stiffness () const
 
virtual unique_ptr< Materialget_copy ()=0
 
int update_incre_status (double)
 
int update_incre_status (double, double)
 
int update_incre_status (double, double, double)
 
int update_trial_status (double)
 
int update_trial_status (double, double)
 
int update_trial_status (double, double, double)
 
virtual int update_incre_status (const vec &)
 
virtual int update_incre_status (const vec &, const vec &)
 
virtual int update_incre_status (const vec &, const vec &, const vec &)
 
virtual int update_trial_status (const vec &)
 
virtual int update_trial_status (const vec &, const vec &)
 
virtual int update_trial_status (const vec &, const vec &, const vec &)
 
int update_couple_incre_status (double)
 
int update_couple_incre_status (double, double)
 
int update_couple_incre_status (double, double, double)
 
int update_couple_trial_status (double)
 
int update_couple_trial_status (double, double)
 
int update_couple_trial_status (double, double, double)
 
virtual int update_couple_incre_status (const vec &)
 
virtual int update_couple_incre_status (const vec &, const vec &)
 
virtual int update_couple_incre_status (const vec &, const vec &, const vec &)
 
virtual int update_couple_trial_status (const vec &)
 
virtual int update_couple_trial_status (const vec &, const vec &)
 
virtual int update_couple_trial_status (const vec &, const vec &, const vec &)
 
virtual int clear_status ()=0
 
virtual int commit_status ()=0
 
virtual int reset_status ()=0
 
virtual int clear_couple_status ()
 
virtual int commit_couple_status ()
 
virtual int reset_couple_status ()
 
virtual std::vector< vec > record (OutputType)
 
- Public Member Functions inherited from Tag
 Tag (unsigned=0)
 
 Tag (const Tag &)=default
 
 Tag (Tag &&)=default
 
Tagoperator= (const Tag &)=delete
 
Tagoperator= (Tag &&)=delete
 
virtual ~Tag ()=default
 
void set_tag (unsigned) const
 
unsigned get_tag () const
 
void enable ()
 
void disable ()
 
void guard ()
 
void unguard ()
 
bool is_active () const
 
bool is_guarded () const
 
virtual void print ()
 

Additional Inherited Members

- Protected Member Functions inherited from Tag
 Tag (unsigned=0)
 
 Tag (const Tag &)=default
 
 Tag (Tag &&)=default
 
Tagoperator= (const Tag &)=delete
 
Tagoperator= (Tag &&)=delete
 
virtual ~Tag ()=default
 
void set_tag (unsigned) const
 
unsigned get_tag () const
 
void enable ()
 
void disable ()
 
void guard ()
 
void unguard ()
 
bool is_active () const
 
bool is_guarded () const
 
virtual void print ()
 
- Protected Attributes inherited from DataMaterial
const double density = 0.
 
const MaterialType material_type = MaterialType::D0
 
const PlaneType plane_type = PlaneType::N
 
const double tolerance = 1E-14
 
const double characteristic_length = -1.
 
vec current_strain {}
 
vec current_strain_rate {}
 
vec current_strain_acc {}
 
vec current_stress {}
 
vec trial_strain {}
 
vec trial_strain_rate {}
 
vec trial_strain_acc {}
 
vec trial_stress {}
 
vec incre_strain {}
 
vec incre_strain_rate {}
 
vec incre_strain_acc {}
 
vec incre_stress {}
 
vec initial_history {}
 
vec current_history {}
 
vec trial_history {}
 
mat initial_stiffness {}
 
mat current_stiffness {}
 
mat trial_stiffness {}
 
mat initial_damping {}
 
mat current_damping {}
 
mat trial_damping {}
 
mat initial_inertial {}
 
mat current_inertial {}
 
mat trial_inertial {}
 
- Protected Attributes inherited from DataCoupleMaterial
vec current_curvature {}
 
vec current_couple_stress {}
 
vec trial_curvature {}
 
vec trial_couple_stress {}
 
vec incre_curvature {}
 
vec incre_couple_stress {}
 
mat initial_couple_stiffness {}
 
mat current_couple_stiffness {}
 
mat trial_couple_stiffness {}
 

Detailed Description

A ExternalMaterial class.

The ExternalMaterial class enables communication across DLL boundary via C style interface. The function has such a signature:

void(*)(ExternalMaterialData* data, int* info);
void info(const std::string_view format_str, const T &... args)
Definition: suanPan.h:249
A ExternalMaterialData class.
Definition: ExternalMaterialData.h:51

On enter, info indicates what kind of operation shall the external model do. The following values are used: 0: acquire memory and initialisation 1: deallocate memory 2: update trial state with strain input only 3: update trial state with strain and strain rate inputs 4: commit trial state 5: reset to current state 6: clear to empty state 7: validate constants

On exit, info indicates if the operation succeeds. The following value is used: 0: success

Author
tlc
Date
15/01/2021
Version
0.1.0

Constructor & Destructor Documentation

◆ ExternalMaterial() [1/3]

ExternalMaterial::ExternalMaterial ( unsigned  T,
std::vector< double > &&  P,
void *  H 
)
Here is the call graph for this function:

◆ ExternalMaterial() [2/3]

ExternalMaterial::ExternalMaterial ( const ExternalMaterial old_obj)
Here is the call graph for this function:

◆ ExternalMaterial() [3/3]

ExternalMaterial::ExternalMaterial ( ExternalMaterial &&  )
deletenoexcept

◆ ~ExternalMaterial()

ExternalMaterial::~ExternalMaterial ( )
override
Here is the call graph for this function:

Member Function Documentation

◆ clear_status()

int ExternalMaterial::clear_status ( )
overridevirtual

Implements Material.

Here is the call graph for this function:

◆ commit_status()

int ExternalMaterial::commit_status ( )
overridevirtual

Implements Material.

Here is the call graph for this function:

◆ get_copy()

unique_ptr< Material > ExternalMaterial::get_copy ( )
overridevirtual

Implements Material.

◆ initialize()

int ExternalMaterial::initialize ( const shared_ptr< DomainBase > &  )
overridevirtual

Implements Material.

Here is the caller graph for this function:

◆ initialize_history()

void ExternalMaterial::initialize_history ( unsigned  )
overridevirtual

Reimplemented from Material.

◆ operator=() [1/2]

ExternalMaterial & ExternalMaterial::operator= ( const ExternalMaterial )
delete

◆ operator=() [2/2]

ExternalMaterial & ExternalMaterial::operator= ( ExternalMaterial &&  )
deletenoexcept

◆ record()

std::vector< vec > ExternalMaterial::record ( OutputType  )
overridevirtual

Reimplemented from Material.

◆ reset_status()

int ExternalMaterial::reset_status ( )
overridevirtual

Implements Material.

Here is the call graph for this function:

◆ set_initial_history()

void ExternalMaterial::set_initial_history ( const vec &  )
overridevirtual

Reimplemented from Material.

◆ update_trial_status() [1/2]

int ExternalMaterial::update_trial_status ( const vec &  t_strain)
overridevirtual

Reimplemented from Material.

Here is the call graph for this function:

◆ update_trial_status() [2/2]

int ExternalMaterial::update_trial_status ( const vec &  t_strain,
const vec &  t_strain_rate 
)
overridevirtual

Reimplemented from Material.

Here is the call graph for this function:

◆ validate()

bool ExternalMaterial::validate ( )
Here is the call graph for this function:

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