oomph::CoupledSolidNode Class Reference

#include <CoupledSolidNodes.h>

+ Inheritance diagram for oomph::CoupledSolidNode:

Public Member Functions

 CoupledSolidNode (const unsigned &n_lagrangian, const unsigned &n_lagrangian_type, const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value)
 
 CoupledSolidNode (TimeStepper *const &time_stepper_pt_, const unsigned &n_lagrangian, const unsigned &n_lagrangian_type, const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value)
 
void set_coupling_weight (const double &weight)
 Set and get function for the coupling weight and force. More...
 
const double get_coupling_weight ()
 
void set_coupling_force (const Vector< double > &cForce)
 
Vector< doubleget_coupling_force () const
 
- Public Member Functions inherited from oomph::SolidNode
 SolidNode ()
 Default Constructor. More...
 
 SolidNode (const unsigned &n_lagrangian, const unsigned &n_lagrangian_type, const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value)
 
 SolidNode (TimeStepper *const &time_stepper_pt, const unsigned &n_lagrangian, const unsigned &n_lagrangian_type, const unsigned &n_dim, const unsigned &Nposition_type, const unsigned &initial_n_value)
 
virtual ~SolidNode ()
 Destructor that cleans up the additional memory allocated in SolidNodes. More...
 
 SolidNode (const SolidNode &solid_node)=delete
 Broken copy constructor. More...
 
void operator= (const SolidNode &)=delete
 Broken assignment operator. More...
 
void copy (SolidNode *orig_node_pt)
 
void dump (std::ostream &dump_file) const
 Dump nodal positions and associated data to file for restart. More...
 
void read (std::ifstream &restart_file)
 Read nodal positions and associated data to file for restart. More...
 
const Datavariable_position () const
 Return the variable_position data (const version) More...
 
Data *const & variable_position_pt () const
 Pointer to variable_position data (const version) More...
 
void set_external_variable_position_pt (Data *const &data_pt)
 Set the variable position data from an external data object. More...
 
void set_position_time_stepper (TimeStepper *const &position_time_stepper_pt, const bool &preserve_existing_data)
 
bool does_pointer_correspond_to_position_data (double *const &parameter_pt)
 Check whether the pointer parameter_pt refers to positional data. More...
 
bool position_is_a_copy () const
 Return whether any position component has been copied. More...
 
bool position_is_a_copy (const unsigned &i) const
 Return whether the position coordinate i has been copied. More...
 
const long & position_eqn_number (const unsigned &k, const unsigned &i) const
 
bool position_is_pinned (const unsigned &i)
 Test whether the i-th coordinate is pinned, 0: false; 1: true. More...
 
bool position_is_pinned (const unsigned &k, const unsigned &i)
 
void pin_position (const unsigned &i)
 Pin the nodal position. More...
 
void pin_position (const unsigned &k, const unsigned &i)
 
void unpin_position (const unsigned &i)
 Unpin the nodal position. More...
 
void unpin_position (const unsigned &k, const unsigned &i)
 
void pin_all ()
 Pin all the stored variables (Overloaded) More...
 
void unpin_all ()
 Unpin all the stored variables (Overloaded) More...
 
void constrain_positions ()
 
void unconstrain_positions ()
 
unsigned nlagrangian () const
 Return number of lagrangian coordinates. More...
 
unsigned nlagrangian_type () const
 
doublexi (const unsigned &i)
 Reference to i-th Lagrangian position. More...
 
const doublexi (const unsigned &i) const
 Reference to i-th Lagrangian position (const version) More...
 
doublexi_gen (const unsigned &k, const unsigned &i)
 
const doublexi_gen (const unsigned &k, const unsigned &i) const
 
double lagrangian_position (const unsigned &i) const
 
double lagrangian_position_gen (const unsigned &k, const unsigned &i) const
 
void assign_eqn_numbers (unsigned long &global_number, Vector< double * > &dof_pt)
 Overload the assign equation numbers routine. More...
 
void describe_dofs (std::ostream &out, const std::string &current_string) const
 
void add_value_pt_to_map (std::map< unsigned, double * > &map_of_value_pt)
 
void node_update (const bool &update_all_time_levels_for_new_node=false)
 
- Public Member Functions inherited from oomph::Node
 Node ()
 Default constructor. More...
 
 Node (const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value, const bool &allocate_x_position=true)
 
 Node (TimeStepper *const &time_stepper_pt, const unsigned &n_dim, const unsigned &n_position_type, const unsigned &initial_n_value, const bool &allocate_x_position=true)
 
virtual ~Node ()
 Destructor: Clean up the memory allocated for nodal position. More...
 
 Node (const Node &node)=delete
 Broken copy constructor. More...
 
void operator= (const Node &)=delete
 Broken assignment operator. More...
 
unsigned nposition_type () const
 
TimeStepper *& position_time_stepper_pt ()
 Return a pointer to the position timestepper. More...
 
TimeStepper *const & position_time_stepper_pt () const
 Return a pointer to the position timestepper (const version). More...
 
unsigned ndim () const
 Return (Eulerian) spatial dimension of the node. More...
 
doublex (const unsigned &i)
 Return the i-th nodal coordinate. More...
 
const doublex (const unsigned &i) const
 Return the i-th nodal coordinate (const version). More...
 
doublex (const unsigned &t, const unsigned &i)
 
const doublex (const unsigned &t, const unsigned &i) const
 
double dx_dt (const unsigned &i) const
 Return the i-th component of nodal velocity: dx/dt. More...
 
double dx_dt (const unsigned &j, const unsigned &i) const
 
virtual Nodecopied_node_pt () const
 
doublex_gen (const unsigned &k, const unsigned &i)
 
const doublex_gen (const unsigned &k, const unsigned &i) const
 
doublex_gen (const unsigned &t, const unsigned &k, const unsigned &i)
 
const doublex_gen (const unsigned &t, const unsigned &k, const unsigned &i) const
 
double dx_gen_dt (const unsigned &k, const unsigned &i) const
 
double dx_gen_dt (const unsigned &j, const unsigned &k, const unsigned &i) const
 
doublex_pt (const unsigned &t, const unsigned &i)
 
void copy (Node *orig_node_pt)
 Copy all nodal data from specified Node object. More...
 
void read (std::ifstream &restart_file)
 Read nodal position and associated data from file for restart. More...
 
unsigned hang_code ()
 
HangInfo *const & hanging_pt () const
 
HangInfo *const & hanging_pt (const int &i) const
 Return pointer to hanging node data for value i (const version) More...
 
bool is_hanging () const
 Test whether the node is geometrically hanging. More...
 
bool is_hanging (const int &i) const
 Test whether the i-th value is hanging. More...
 
void set_hanging_pt (HangInfo *const &hang_pt, const int &i)
 Set the hanging data for the i-th value. (hang_pt=0 to make non-hanging) More...
 
void set_nonhanging ()
 Label node as non-hanging node by removing all hanging node data. More...
 
void resize (const unsigned &n_value)
 Resize the number of equations. More...
 
virtual void make_periodic (Node *const &node_pt)
 
virtual void make_periodic_nodes (const Vector< Node * > &periodic_nodes_pt)
 
virtual void get_boundaries_pt (std::set< unsigned > *&boundaries_pt)
 
virtual bool is_on_boundary () const
 
virtual bool is_on_boundary (const unsigned &b) const
 
virtual void add_to_boundary (const unsigned &b)
 
virtual void remove_from_boundary (const unsigned &b)
 
virtual unsigned ncoordinates_on_boundary (const unsigned &b)
 
virtual bool boundary_coordinates_have_been_set_up ()
 
virtual void get_coordinates_on_boundary (const unsigned &b, const unsigned &k, Vector< double > &boundary_zeta)
 
virtual void set_coordinates_on_boundary (const unsigned &b, const unsigned &k, const Vector< double > &boundary_zeta)
 
virtual void get_coordinates_on_boundary (const unsigned &b, Vector< double > &boundary_zeta)
 
virtual void set_coordinates_on_boundary (const unsigned &b, const Vector< double > &boundary_zeta)
 
void set_obsolete ()
 Mark node as obsolete. More...
 
void set_non_obsolete ()
 Mark node as non-obsolete. More...
 
bool is_obsolete ()
 Test whether node is obsolete. More...
 
double raw_value (const unsigned &i) const
 
double raw_value (const unsigned &t, const unsigned &i) const
 
double value (const unsigned &i) const
 
double value (const unsigned &t, const unsigned &i) const
 
void value (Vector< double > &values) const
 
Vector< doublevalue () const
 Return vector of values calculated using value(vector). More...
 
void value (const unsigned &t, Vector< double > &values) const
 
void position (Vector< double > &pos) const
 
Vector< doubleposition () const
 Return vector of position of node at current time. More...
 
void position (const unsigned &t, Vector< double > &pos) const
 
double position (const unsigned &i) const
 
double position (const unsigned &t, const unsigned &i) const
 
double position_gen (const unsigned &k, const unsigned &i) const
 
double position_gen (const unsigned &t, const unsigned &k, const unsigned &i) const
 
double dposition_dt (const unsigned &i) const
 
double dposition_dt (const unsigned &j, const unsigned &i) const
 
double dposition_gen_dt (const unsigned &k, const unsigned &i) const
 
double dposition_gen_dt (const unsigned &j, const unsigned &k, const unsigned &i) const
 
void set_auxiliary_node_update_fct_pt (AuxNodeUpdateFctPt aux_node_update_fct_pt)
 
bool has_auxiliary_node_update_fct_pt ()
 
void perform_auxiliary_node_update_fct ()
 
virtual unsigned ngeom_data () const
 
virtual Data ** all_geom_data_pt ()
 
virtual unsigned ngeom_object () const
 
virtual GeomObject ** all_geom_object_pt ()
 
void output (std::ostream &outfile)
 Output nodal position. More...
 
- Public Member Functions inherited from oomph::Data
virtual void clear_copied_pointers ()
 
 Data ()
 Default constructor. More...
 
 Data (const unsigned &initial_n_value)
 
 Data (TimeStepper *const &time_stepper_pt, const unsigned &initial_n_value, const bool &allocate_storage=true)
 
 Data (const Data &data)=delete
 Broken copy constructor. More...
 
void operator= (const Data &)=delete
 Broken assignment operator. More...
 
virtual ~Data ()
 Destructor, deallocates memory assigned for data. More...
 
void set_time_stepper (TimeStepper *const &time_stepper_pt, const bool &preserve_existing_data)
 
TimeStepper *& time_stepper_pt ()
 Return the pointer to the timestepper. More...
 
TimeStepper *const & time_stepper_pt () const
 Return the pointer to the timestepper (const version). More...
 
virtual bool is_a_copy () const
 
virtual bool is_a_copy (const unsigned &i) const
 
void set_value (const unsigned &i, const double &value_)
 
void set_value (const unsigned &t, const unsigned &i, const double &value_)
 
double value (const unsigned &i) const
 
double value (const unsigned &t, const unsigned &i) const
 
void value (Vector< double > &values) const
 Compute Vector of values for the Data value. More...
 
void value (const unsigned &t, Vector< double > &values) const
 
doublevalue_pt (const unsigned &i) const
 
doublevalue_pt (const unsigned &t, const unsigned &i) const
 
bool does_pointer_correspond_to_value (double *const &parameter_pt)
 Check whether the pointer parameter_pt addresses internal data values. More...
 
void copy (Data *orig_data_pt)
 Copy Data values from specified Data object. More...
 
void dump (std::ostream &dump_file) const
 Dump the data object to a file. More...
 
void read (std::ifstream &restart_file)
 Read data object from a file. More...
 
long * eqn_number_pt (const unsigned &i)
 Return the pointer to the equation number of the i-th stored variable. More...
 
long & eqn_number (const unsigned &i)
 Return the equation number of the i-th stored variable. More...
 
long eqn_number (const unsigned &i) const
 Return the equation number of the i-th stored variable. More...
 
void pin (const unsigned &i)
 Pin the i-th stored variable. More...
 
void unpin (const unsigned &i)
 Unpin the i-th stored variable. More...
 
void pin_all ()
 Pin all the stored variables. More...
 
void unpin_all ()
 Unpin all the stored variables. More...
 
bool is_pinned (const unsigned &i) const
 Test whether the i-th variable is pinned (1: true; 0: false). More...
 
bool is_segregated_solve_pinned (const unsigned &i)
 
void constrain (const unsigned &i)
 
void unconstrain (const unsigned &i)
 
void constrain_all ()
 Constrain all the stored variables when the data is made hanging. More...
 
void unconstrain_all ()
 Unconstrain all the stored variables when the data is made nonhanging. More...
 
bool is_constrained (const unsigned &i)
 
unsigned self_test ()
 
unsigned nvalue () const
 Return number of values stored in data object (incl pinned ones). More...
 
unsigned ntstorage () const
 

Private Attributes

double coupling_weight
 Weighting factor for coupling with other method. More...
 
Vector< doublecoupling_force
 Coupling force on the node. More...
 

Additional Inherited Members

- Public Types inherited from oomph::Node
typedef void(* AuxNodeUpdateFctPt) (Node *)
 Function pointer to auxiliary node update function. More...
 
- Static Public Attributes inherited from oomph::Node
static unsigned No_independent_position = 10
 
- Static Public Attributes inherited from oomph::Data
static long Is_pinned = -1
 Static "Magic number" to indicate pinned values. More...
 
static long Is_segregated_solve_pinned = -3
 
static long Is_unclassified = -10
 
static long Is_constrained = -2
 
- Protected Member Functions inherited from oomph::Node
void x_gen_range_check (const unsigned &t, const unsigned &k, const unsigned &i) const
 
doublex_position_pt (const unsigned &i)
 Direct access to the pointer to the i-th stored coordinate data. More...
 
- Protected Member Functions inherited from oomph::Data
virtual void reset_copied_pointers ()
 
- Protected Attributes inherited from oomph::SolidNode
unsigned Nlagrangian
 Number of Lagrangian coordinates of the node. More...
 
unsigned Nlagrangian_type
 
DataVariable_position_pt
 Pointer to data that will hold variable positions in elastic nodes. More...
 
doubleXi_position
 Storage for the Lagrangian positions. More...
 
- Protected Attributes inherited from oomph::Node
double ** X_position
 
TimeStepperPosition_time_stepper_pt
 Pointer to the timestepper associated with the position data. More...
 
HangInfo ** Hanging_pt
 
unsigned Ndim
 Eulerian dimension of the node. More...
 
unsigned Nposition_type
 
bool Obsolete
 
AuxNodeUpdateFctPt Aux_node_update_fct_pt
 
- Protected Attributes inherited from oomph::Data
Data ** Copy_of_data_pt
 
unsigned Ncopies
 
- Static Protected Attributes inherited from oomph::Data
static TimeStepperDefault_static_time_stepper_pt = new Steady<0>()
 Default (static) timestepper used in steady problems. More...
 

Detailed Description

adds a coupling weight and coupling force to each SolidNode

Constructor & Destructor Documentation

◆ CoupledSolidNode() [1/2]

oomph::CoupledSolidNode::CoupledSolidNode ( const unsigned n_lagrangian,
const unsigned n_lagrangian_type,
const unsigned n_dim,
const unsigned n_position_type,
const unsigned initial_n_value 
)
inline
35  : SolidNode(n_lagrangian, n_lagrangian_type, n_dim, n_position_type, initial_n_value) {}
SolidNode()
Default Constructor.
Definition: nodes.h:1708

◆ CoupledSolidNode() [2/2]

oomph::CoupledSolidNode::CoupledSolidNode ( TimeStepper *const &  time_stepper_pt_,
const unsigned n_lagrangian,
const unsigned n_lagrangian_type,
const unsigned n_dim,
const unsigned n_position_type,
const unsigned initial_n_value 
)
inline
43  : SolidNode(time_stepper_pt_, n_lagrangian, n_lagrangian_type, n_dim, n_position_type, initial_n_value) {}

Member Function Documentation

◆ get_coupling_force()

Vector<double> oomph::CoupledSolidNode::get_coupling_force ( ) const
inline
52 { return coupling_force; }
Vector< double > coupling_force
Coupling force on the node.
Definition: CoupledSolidNodes.h:26

References coupling_force.

◆ get_coupling_weight()

const double oomph::CoupledSolidNode::get_coupling_weight ( )
inline
48 { return coupling_weight; }
double coupling_weight
Weighting factor for coupling with other method.
Definition: CoupledSolidNodes.h:23

References coupling_weight.

◆ set_coupling_force()

void oomph::CoupledSolidNode::set_coupling_force ( const Vector< double > &  cForce)
inline
50 { coupling_force = cForce; }

References coupling_force.

◆ set_coupling_weight()

void oomph::CoupledSolidNode::set_coupling_weight ( const double weight)
inline

Set and get function for the coupling weight and force.

46 { coupling_weight = weight; }

References coupling_weight.

Member Data Documentation

◆ coupling_force

Vector<double> oomph::CoupledSolidNode::coupling_force
private

Coupling force on the node.

Referenced by get_coupling_force(), and set_coupling_force().

◆ coupling_weight

double oomph::CoupledSolidNode::coupling_weight
private

Weighting factor for coupling with other method.

Referenced by get_coupling_weight(), and set_coupling_weight().


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