Flow123d  release_2.2.0-914-gf1a3a4f
Public Member Functions | List of all members
BCField< spacedim, Value > Class Template Reference

#include <bc_field.hh>

Inheritance diagram for BCField< spacedim, Value >:
Inheritance graph
[legend]
Collaboration diagram for BCField< spacedim, Value >:
Collaboration graph
[legend]

Public Member Functions

 BCField ()
 
- Public Member Functions inherited from Field< spacedim, Value >
 Field ()
 
 Field (const string &name, bool bc=false)
 
 Field (unsigned int component_index, string input_name, string name="", bool bc=false)
 
 Field (const Field &other)
 
Fieldoperator= (const Field &other)
 
IT::Instance get_input_type () override
 
IT::Array get_multifield_input_type () override
 
auto disable_where (const Field< spacedim, typename FieldValue< spacedim >::Enum > &control_field, const vector< FieldEnum > &value_list) -> Field &
 
void set_mesh (const Mesh &mesh) override
 
bool is_constant (Region reg) override
 
void set_field (const RegionSet &domain, FieldBasePtr field, double time=0.0)
 
void set_field (const RegionSet &domain, const Input::AbstractRecord &a_rec, double time=0.0)
 
bool set_time (const TimeStep &time, LimitSide limit_side) override
 
void copy_from (const FieldCommon &other) override
 
void field_output (std::shared_ptr< OutputTime > stream) override
 
void observe_output (std::shared_ptr< Observe > observe) override
 
FieldResult field_result (RegionSet region_set) const override
 Indicates special field states. More...
 
std::string get_value_attribute () const override
 
virtual Value::return_type const & value (const Point &p, const ElementAccessor< spacedim > &elm) const
 
virtual void value_list (const std::vector< Point > &point_list, const ElementAccessor< spacedim > &elm, std::vector< typename Value::return_type > &value_list) const
 
void add_factory (std::shared_ptr< FactoryBase > factory)
 
void set_input_list (const Input::Array &list) override
 
void compute_field_data (OutputTime::DiscreteSpace space_type, std::shared_ptr< OutputTime > stream)
 
- Public Member Functions inherited from FieldCommon
 TYPEDEF_ERR_INFO (EI_Time, double)
 
 TYPEDEF_ERR_INFO (EI_Field, std::string)
 
 DECLARE_INPUT_EXCEPTION (ExcNonascendingTime,<< "Non-ascending time: "<< EI_Time::val<< " for field "<< EI_Field::qval<< ".\n")
 
 DECLARE_INPUT_EXCEPTION (ExcMissingDomain,<< "Missing domain specification (region or r_id) in the field descriptor:")
 
 DECLARE_EXCEPTION (ExcFieldMeshDifference,<< "Two copies of the field "<< EI_Field::qval<< "call set_mesh with different arguments.\n")
 
FieldCommonname (const string &name)
 
FieldCommondescription (const string &description)
 
FieldCommoninput_default (const string &input_default)
 
FieldCommonunits (const UnitSI &units)
 Set basic units of the field. More...
 
FieldCommonset_limits (double min, double max=std::numeric_limits< double >::max())
 
FieldCommoninput_selection (Input::Type::Selection element_selection)
 
FieldCommonoutput_type (OutputTime::DiscreteSpace rt)
 
FieldCommonflags (FieldFlag::Flags::Mask mask)
 
FieldCommonflags_add (FieldFlag::Flags::Mask mask)
 
void set_components (const std::vector< string > &names)
 
const std::string & input_name () const
 
const std::string & name () const
 
const std::string description () const
 
const std::string & input_default () const
 
const UnitSIunits () const
 
std::pair< double, double > limits () const
 
OutputTime::DiscreteSpace get_output_type () const
 
bool is_bc () const
 
unsigned int n_comp () const
 
const Meshmesh () const
 
FieldFlag::Flagsflags ()
 
FieldFlag::Flags get_flags () const
 
double time () const
 
bool is_jump_time ()
 
unsigned int input_list_size () const
 
bool changed () const
 
void mark_input_times (const TimeGovernor &tg)
 
void set_component_index (unsigned int idx)
 
bool is_multifield () const
 
virtual ~FieldCommon ()
 

Additional Inherited Members

- Public Types inherited from Field< spacedim, Value >
typedef FieldAlgorithmBase< spacedim, ValueFieldBaseType
 
typedef std::shared_ptr< FieldBaseTypeFieldBasePtr
 
typedef FieldAlgorithmBase< spacedim, Value >::Point Point
 
typedef Value ValueType
 
- Static Public Member Functions inherited from FieldCommon
static IT::Record field_descriptor_record (const string &record_name)
 
static const std::string field_descriptor_record_description (const string &record_name)
 
static bool print_message_table (ostream &stream, std::string equation_name)
 
- Static Public Attributes inherited from Field< spacedim, Value >
static const unsigned int space_dim = spacedim
 
- Protected Types inherited from Field< spacedim, Value >
typedef pair< double, FieldBasePtrHistoryPoint
 Pair: time, pointer to FieldBase instance. More...
 
typedef boost::circular_buffer< HistoryPointRegionHistory
 Nearest history of one region. More...
 
typedef Field< spacedim, typename FieldValue< spacedim >::Enum > ControlField
 
- Protected Types inherited from FieldCommon
enum  TimeStatus { TimeStatus::changed, TimeStatus::constant, TimeStatus::unknown }
 
- Protected Member Functions inherited from Field< spacedim, Value >
void update_history (const TimeStep &time)
 
void check_initialized_region_fields_ ()
 
std::shared_ptr< FieldFE< spacedim, Value > > get_field_fe ()
 
- Protected Member Functions inherited from FieldCommon
 FieldCommon ()
 
 FieldCommon (const FieldCommon &other)
 
void set_history_changed ()
 
- Protected Attributes inherited from Field< spacedim, Value >
std::shared_ptr< SharedDatadata_
 
std::shared_ptr< ControlFieldno_check_control_field_
 
std::vector< FieldBasePtrregion_fields_
 
std::vector< std::shared_ptr< FactoryBase > > factories_
 
- Protected Attributes inherited from FieldCommon
std::string name_
 
std::shared_ptr< SharedDatashared_
 
TimeStatus set_time_result_
 
double last_time_ = -numeric_limits<double>::infinity()
 
LimitSide last_limit_side_ = LimitSide::left
 
bool is_jump_time_
 
OutputTime::DiscreteSpace type_of_output_data_ = OutputTime::ELEM_DATA
 
unsigned int component_index_
 
bool multifield_
 
FieldFlag::Flags flags_ = FieldFlag::declare_input & FieldFlag::equation_input & FieldFlag::allow_output
 Field flags. Default setting is "an equation input field, that can read from user input, and can be written to output". More...
 
- Static Protected Attributes inherited from FieldCommon
static const unsigned int history_length_limit_ =3
 
static std::vector< MessageDatamessages_data_ = std::vector<FieldCommon::MessageData>()
 Vector of data of initialization messages. More...
 

Detailed Description

template<int spacedim, class Value>
class BCField< spacedim, Value >

Same as Field<...> but for boundary regions.

Definition of BCField must be in separate file. In other case source file field.cc is too big and compiler can throw compile error.

Definition at line 32 of file bc_field.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value>
BCField< spacedim, Value >::BCField ( )
inline

Definition at line 34 of file bc_field.hh.


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