#include <nodes.h>

Inheritance diagram for oomph::CopiedData:

Public Member Functions
void	clear_copied_pointers ()
	Clear the pointers to the copied data. More...

	CopiedData (Data *const &data_pt)
	Constructor. More...

	CopiedData (const Data &data)=delete
	(Shallow) copy constructor More...

void	operator= (const CopiedData &)=delete
	Broken assignment operator. More...

	~CopiedData ()

bool	is_a_copy () const

bool	is_a_copy (const unsigned &i) const

void	assign_eqn_numbers (unsigned long &global_ndof, Vector< double * > &dof_pt)

void	resize (const unsigned &n_value)
	We do not allow Copied Data to be resized. More...

Public Member Functions inherited from oomph::Data
	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...

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

double *	value_pt (const unsigned &i) const

double *	value_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

virtual void	describe_dofs (std::ostream &out, const std::string &current_string) const

virtual void	add_value_pt_to_map (std::map< unsigned, double * > &map_of_value_pt)

Private Member Functions
void	reset_copied_pointers ()
	Reset the pointers to the copied data. More...

Private Attributes
Data *	Copied_data_pt
	Pointer to the Data object from which the values are copied. More...

Additional Inherited Members
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 Attributes inherited from oomph::Data
Data **	Copy_of_data_pt

unsigned	Ncopies

Static Protected Attributes inherited from oomph::Data
static TimeStepper *	Default_static_time_stepper_pt = new Steady<0>()
	Default (static) timestepper used in steady problems. More...

Detailed Description

Custom Data class that is used when making a shallow copy of a data object. The class contains a copy of an entire other Data object.

Constructor & Destructor Documentation

◆ CopiedData() [1/2]

oomph::CopiedData::CopiedData ( Data *const & data_pt )

Constructor.

Constructor, creates a CopiedData object with all values copied from another Data object.

     : Data(data_pt->time_stepper_pt(), data_pt->nvalue(), false),
       Copied_data_pt(data_pt)
   {
     // Don't allow copying of a copy
     if (data_pt->is_a_copy())
     {
       std::ostringstream error_stream;
       error_stream << "The data you are trying to copy is already a copy"
                    << std::endl;
       error_stream << "Please copy the original data" << std::endl;
       error_stream << "In a later version, I might do this for you,"
                    << " but not today" << std::endl;
  
       throw OomphLibError(
         error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
     }
  
     // Copy the pointer to the value.
     Value = data_pt->Value;
     // Copy the pointer to the equation number
     Eqn_number = data_pt->Eqn_number;
     // Inform the original data that it has been copied
     data_pt->add_copy(this);
   }

References oomph::Data::add_copy(), oomph::Data::Eqn_number, oomph::Data::is_a_copy(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, and oomph::Data::Value.

◆ CopiedData() [2/2]

oomph::CopiedData::CopiedData ( const Data & data )

delete

(Shallow) copy constructor

◆ ~CopiedData()

oomph::CopiedData::~CopiedData ( )

inline

Destructor informs original object that the copy is being deleted and clears its pointers to the stored values.

     {
       // Inform the Copied data that this copy is being deleted
       // If the original has already been deleted
       // Copied_data_pt will be set to NULL and this will not be
       // necessary
       if (Copied_data_pt)
       {
         Copied_data_pt->remove_copy(this);
       }
       // Now null out the storage
       Copied_data_pt = 0;
       Value = 0;
       Eqn_number = 0;
     }

References Copied_data_pt, oomph::Data::Eqn_number, oomph::Data::remove_copy(), and oomph::Data::Value.

Member Function Documentation

◆ assign_eqn_numbers()

void oomph::CopiedData::assign_eqn_numbers	(	unsigned long &	global_ndof,
		Vector< double * > &	dof_pt
	)

inlinevirtual

CopiedData is always a copy, so no equation numbers should be allocated. This function just returns.

Reimplemented from oomph::Data.

     {
       return;
     }

◆ clear_copied_pointers()

void oomph::CopiedData::clear_copied_pointers ( )

virtual

Clear the pointers to the copied data.

Clear ther pointers to the copied data.

Reimplemented from oomph::Data.

   {
     Copied_data_pt = 0;
     Value = 0;
     Eqn_number = 0;
   }

References Copied_data_pt, oomph::Data::Eqn_number, and oomph::Data::Value.

◆ is_a_copy() [1/2]

bool oomph::CopiedData::is_a_copy ( ) const

inlinevirtual

Return a boolean to indicate whether the data contains any copied values. Copied data is always a copy

Reimplemented from oomph::Data.

     {
       return true;
     }

◆ is_a_copy() [2/2]

bool oomph::CopiedData::is_a_copy ( const unsigned & i ) const

inlinevirtual

Return a boolean to indicate whether the i-th value is a copied value. All copied data is always a copy

Reimplemented from oomph::Data.

     {
       return true;
     }

◆ operator=()

void oomph::CopiedData::operator= ( const CopiedData & )

delete

Broken assignment operator.

◆ reset_copied_pointers()

void oomph::CopiedData::reset_copied_pointers ( )

privatevirtual

Reset the pointers to the copied data.

/////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////

Reimplemented from oomph::Data.

   {
     // Set the new number of values
     Nvalue = Copied_data_pt->nvalue();
  
     // Copy the pointer to the value. This will give the appropriate
     //"slice" of the array
     Value = Copied_data_pt->Value;
  
     // Copy the pointer to the equation numbers
     Eqn_number = Copied_data_pt->Eqn_number;
   }

References Copied_data_pt, oomph::Data::Eqn_number, oomph::Data::Nvalue, oomph::Data::nvalue(), and oomph::Data::Value.

◆ resize()

void oomph::CopiedData::resize ( const unsigned & n_value )

virtual

We do not allow Copied Data to be resized.

We cannot resize CopiedData, so the resize function throws a warning.

Reimplemented from oomph::Data.

   {
     throw OomphLibError("CopiedData cannot be resized",
                         OOMPH_CURRENT_FUNCTION,
                         OOMPH_EXCEPTION_LOCATION);
   }

References OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

Member Data Documentation

◆ Copied_data_pt

Data* oomph::CopiedData::Copied_data_pt

private

Pointer to the Data object from which the values are copied.

Referenced by clear_copied_pointers(), reset_copied_pointers(), and ~CopiedData().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CopiedData() [1/2]

◆ CopiedData() [2/2]

◆ ~CopiedData()

Member Function Documentation

◆ assign_eqn_numbers()

◆ clear_copied_pointers()

◆ is_a_copy() [1/2]

◆ is_a_copy() [2/2]

◆ operator=()

◆ reset_copied_pointers()

◆ resize()

Member Data Documentation

◆ Copied_data_pt